curl --request PATCH \
--url https://api.orbit.devotel.io/api/v1/numbers/tracking-pools/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"label": "<string>",
"source": "<string>",
"campaign": "<string>",
"medium": "<string>",
"match": {
"utmSource": "<string>",
"utmMedium": "<string>",
"utmCampaign": "<string>",
"utmTerm": "<string>",
"referrerContains": "<string>",
"requireGclid": true
},
"enabled": true
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/numbers/tracking-pools/{id}"
payload = {
"label": "<string>",
"source": "<string>",
"campaign": "<string>",
"medium": "<string>",
"match": {
"utmSource": "<string>",
"utmMedium": "<string>",
"utmCampaign": "<string>",
"utmTerm": "<string>",
"referrerContains": "<string>",
"requireGclid": True
},
"enabled": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
label: '<string>',
source: '<string>',
campaign: '<string>',
medium: '<string>',
match: {
utmSource: '<string>',
utmMedium: '<string>',
utmCampaign: '<string>',
utmTerm: '<string>',
referrerContains: '<string>',
requireGclid: true
},
enabled: true
})
};
fetch('https://api.orbit.devotel.io/api/v1/numbers/tracking-pools/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.orbit.devotel.io/api/v1/numbers/tracking-pools/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'label' => '<string>',
'source' => '<string>',
'campaign' => '<string>',
'medium' => '<string>',
'match' => [
'utmSource' => '<string>',
'utmMedium' => '<string>',
'utmCampaign' => '<string>',
'utmTerm' => '<string>',
'referrerContains' => '<string>',
'requireGclid' => true
],
'enabled' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.orbit.devotel.io/api/v1/numbers/tracking-pools/{id}"
payload := strings.NewReader("{\n \"label\": \"<string>\",\n \"source\": \"<string>\",\n \"campaign\": \"<string>\",\n \"medium\": \"<string>\",\n \"match\": {\n \"utmSource\": \"<string>\",\n \"utmMedium\": \"<string>\",\n \"utmCampaign\": \"<string>\",\n \"utmTerm\": \"<string>\",\n \"referrerContains\": \"<string>\",\n \"requireGclid\": true\n },\n \"enabled\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.orbit.devotel.io/api/v1/numbers/tracking-pools/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"label\": \"<string>\",\n \"source\": \"<string>\",\n \"campaign\": \"<string>\",\n \"medium\": \"<string>\",\n \"match\": {\n \"utmSource\": \"<string>\",\n \"utmMedium\": \"<string>\",\n \"utmCampaign\": \"<string>\",\n \"utmTerm\": \"<string>\",\n \"referrerContains\": \"<string>\",\n \"requireGclid\": true\n },\n \"enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/numbers/tracking-pools/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"label\": \"<string>\",\n \"source\": \"<string>\",\n \"campaign\": \"<string>\",\n \"medium\": \"<string>\",\n \"match\": {\n \"utmSource\": \"<string>\",\n \"utmMedium\": \"<string>\",\n \"utmCampaign\": \"<string>\",\n \"utmTerm\": \"<string>\",\n \"referrerContains\": \"<string>\",\n \"requireGclid\": true\n },\n \"enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"label": "<string>",
"source": "<string>",
"match": {
"utmSource": "<string>",
"utmMedium": "<string>",
"utmCampaign": "<string>",
"utmTerm": "<string>",
"referrerContains": "<string>",
"requireGclid": true
},
"trackingDids": [
"<string>"
],
"swapStrategy": "sticky",
"enabled": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"campaign": "<string>",
"medium": "<string>"
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Update a tracking pool
Edit a pool’s label/source/campaign/medium/match/swapStrategy/enabled. At least one field must be supplied. Tracking DIDs are managed via the assign/unassign endpoints, not this one. Owner/admin/developer only.
curl --request PATCH \
--url https://api.orbit.devotel.io/api/v1/numbers/tracking-pools/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"label": "<string>",
"source": "<string>",
"campaign": "<string>",
"medium": "<string>",
"match": {
"utmSource": "<string>",
"utmMedium": "<string>",
"utmCampaign": "<string>",
"utmTerm": "<string>",
"referrerContains": "<string>",
"requireGclid": true
},
"enabled": true
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/numbers/tracking-pools/{id}"
payload = {
"label": "<string>",
"source": "<string>",
"campaign": "<string>",
"medium": "<string>",
"match": {
"utmSource": "<string>",
"utmMedium": "<string>",
"utmCampaign": "<string>",
"utmTerm": "<string>",
"referrerContains": "<string>",
"requireGclid": True
},
"enabled": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
label: '<string>',
source: '<string>',
campaign: '<string>',
medium: '<string>',
match: {
utmSource: '<string>',
utmMedium: '<string>',
utmCampaign: '<string>',
utmTerm: '<string>',
referrerContains: '<string>',
requireGclid: true
},
enabled: true
})
};
fetch('https://api.orbit.devotel.io/api/v1/numbers/tracking-pools/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.orbit.devotel.io/api/v1/numbers/tracking-pools/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'label' => '<string>',
'source' => '<string>',
'campaign' => '<string>',
'medium' => '<string>',
'match' => [
'utmSource' => '<string>',
'utmMedium' => '<string>',
'utmCampaign' => '<string>',
'utmTerm' => '<string>',
'referrerContains' => '<string>',
'requireGclid' => true
],
'enabled' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.orbit.devotel.io/api/v1/numbers/tracking-pools/{id}"
payload := strings.NewReader("{\n \"label\": \"<string>\",\n \"source\": \"<string>\",\n \"campaign\": \"<string>\",\n \"medium\": \"<string>\",\n \"match\": {\n \"utmSource\": \"<string>\",\n \"utmMedium\": \"<string>\",\n \"utmCampaign\": \"<string>\",\n \"utmTerm\": \"<string>\",\n \"referrerContains\": \"<string>\",\n \"requireGclid\": true\n },\n \"enabled\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.orbit.devotel.io/api/v1/numbers/tracking-pools/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"label\": \"<string>\",\n \"source\": \"<string>\",\n \"campaign\": \"<string>\",\n \"medium\": \"<string>\",\n \"match\": {\n \"utmSource\": \"<string>\",\n \"utmMedium\": \"<string>\",\n \"utmCampaign\": \"<string>\",\n \"utmTerm\": \"<string>\",\n \"referrerContains\": \"<string>\",\n \"requireGclid\": true\n },\n \"enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/numbers/tracking-pools/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"label\": \"<string>\",\n \"source\": \"<string>\",\n \"campaign\": \"<string>\",\n \"medium\": \"<string>\",\n \"match\": {\n \"utmSource\": \"<string>\",\n \"utmMedium\": \"<string>\",\n \"utmCampaign\": \"<string>\",\n \"utmTerm\": \"<string>\",\n \"referrerContains\": \"<string>\",\n \"requireGclid\": true\n },\n \"enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"label": "<string>",
"source": "<string>",
"match": {
"utmSource": "<string>",
"utmMedium": "<string>",
"utmCampaign": "<string>",
"utmTerm": "<string>",
"referrerContains": "<string>",
"requireGclid": true
},
"trackingDids": [
"<string>"
],
"swapStrategy": "sticky",
"enabled": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"campaign": "<string>",
"medium": "<string>"
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Authorizations
Dashboard JWT token from Clerk
Path Parameters
Tracking-pool id.
Body
1 - 1201 - 120200120Match rule set the DNI resolver scores a visitor against. A pool matches when EVERY defined condition holds; an undefined condition is "don't care".
Show child attributes
Show child attributes
sticky, fixed Response
The updated tracking pool.
A CXaaS call-tracking (Dynamic Number Insertion) pool — a marketing source/campaign bound to a set of swappable inbound tracking DIDs. Persists in org-settings JSONB. Inbound termination only (Invariant #45): a tracking pool never wires an outbound (MT) voice/SMS path.
Show child attributes
Show child attributes
Show child attributes
Show child attributes