Update or pause an Orbit audience destination
curl --request PATCH \
--url https://api.aws53.cloud/v1/intent/audiences/{audienceId}/destinations/{destinationId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"status": "paused"
}
'import requests
url = "https://api.aws53.cloud/v1/intent/audiences/{audienceId}/destinations/{destinationId}"
payload = { "status": "paused" }
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({status: 'paused'})
};
fetch('https://api.aws53.cloud/v1/intent/audiences/{audienceId}/destinations/{destinationId}', 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.aws53.cloud/v1/intent/audiences/{audienceId}/destinations/{destinationId}",
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([
'status' => 'paused'
]),
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.aws53.cloud/v1/intent/audiences/{audienceId}/destinations/{destinationId}"
payload := strings.NewReader("{\n \"status\": \"paused\"\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.aws53.cloud/v1/intent/audiences/{audienceId}/destinations/{destinationId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"status\": \"paused\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aws53.cloud/v1/intent/audiences/{audienceId}/destinations/{destinationId}")
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 \"status\": \"paused\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"destination": {
"id": "22222222-2222-4222-8222-222222222222",
"organizationId": "33333333-3333-4333-8333-333333333333",
"audienceId": "11111111-1111-4111-8111-111111111111",
"name": "Example contact webhook",
"destinationType": "webhook",
"status": "paused",
"validationPolicy": "valid_or_catchall",
"configRevision": 1,
"approvedConfigHash": null,
"lastSuccessfulRunId": null,
"initialSyncCompletedAt": null,
"stats": {
"totalSynced": 0,
"totalSkipped": 0,
"totalFailed": 0,
"consecutiveErrors": 0,
"lastDeliveredAt": null,
"lastErrorCode": null,
"lastErrorMessage": null,
"lastErrorAt": null
},
"webhook": {
"url": "https://integrations.example.test/intent",
"signingVersion": "v1",
"eventTypes": [
"intent.audience.contact.upserted"
],
"timeoutMs": 10000
},
"pipedream": null,
"createdAt": "2026-01-15T12:00:00.000Z",
"updatedAt": "2026-01-15T12:00:00.000Z"
}
},
"meta": {
"timestamp": "2026-01-15T12:00:00.000Z",
"request_id": "example-request"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
},
"meta": {
"timestamp": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
},
"meta": {
"timestamp": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
},
"meta": {
"timestamp": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
},
"meta": {
"timestamp": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
},
"meta": {
"timestamp": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
},
"meta": {
"timestamp": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
},
"meta": {
"timestamp": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
},
"meta": {
"timestamp": "<string>",
"request_id": "<string>"
}
}Destinations
Update or pause an Orbit audience destination
Updates or pauses a destination belonging to the authenticated organization. Requires a non-viewer member using bearer authentication. Configuration changes reset the delivery baseline; pausing cancels pending deliveries. This operation does not activate a destination. Requests share a 120-per-60-second allowance per source IP within this integration, destination, or delivery route family.
PATCH
/
v1
/
intent
/
audiences
/
{audienceId}
/
destinations
/
{destinationId}
Update or pause an Orbit audience destination
curl --request PATCH \
--url https://api.aws53.cloud/v1/intent/audiences/{audienceId}/destinations/{destinationId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"status": "paused"
}
'import requests
url = "https://api.aws53.cloud/v1/intent/audiences/{audienceId}/destinations/{destinationId}"
payload = { "status": "paused" }
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({status: 'paused'})
};
fetch('https://api.aws53.cloud/v1/intent/audiences/{audienceId}/destinations/{destinationId}', 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.aws53.cloud/v1/intent/audiences/{audienceId}/destinations/{destinationId}",
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([
'status' => 'paused'
]),
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.aws53.cloud/v1/intent/audiences/{audienceId}/destinations/{destinationId}"
payload := strings.NewReader("{\n \"status\": \"paused\"\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.aws53.cloud/v1/intent/audiences/{audienceId}/destinations/{destinationId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"status\": \"paused\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aws53.cloud/v1/intent/audiences/{audienceId}/destinations/{destinationId}")
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 \"status\": \"paused\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"destination": {
"id": "22222222-2222-4222-8222-222222222222",
"organizationId": "33333333-3333-4333-8333-333333333333",
"audienceId": "11111111-1111-4111-8111-111111111111",
"name": "Example contact webhook",
"destinationType": "webhook",
"status": "paused",
"validationPolicy": "valid_or_catchall",
"configRevision": 1,
"approvedConfigHash": null,
"lastSuccessfulRunId": null,
"initialSyncCompletedAt": null,
"stats": {
"totalSynced": 0,
"totalSkipped": 0,
"totalFailed": 0,
"consecutiveErrors": 0,
"lastDeliveredAt": null,
"lastErrorCode": null,
"lastErrorMessage": null,
"lastErrorAt": null
},
"webhook": {
"url": "https://integrations.example.test/intent",
"signingVersion": "v1",
"eventTypes": [
"intent.audience.contact.upserted"
],
"timeoutMs": 10000
},
"pipedream": null,
"createdAt": "2026-01-15T12:00:00.000Z",
"updatedAt": "2026-01-15T12:00:00.000Z"
}
},
"meta": {
"timestamp": "2026-01-15T12:00:00.000Z",
"request_id": "example-request"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
},
"meta": {
"timestamp": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
},
"meta": {
"timestamp": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
},
"meta": {
"timestamp": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
},
"meta": {
"timestamp": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
},
"meta": {
"timestamp": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
},
"meta": {
"timestamp": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
},
"meta": {
"timestamp": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
},
"meta": {
"timestamp": "<string>",
"request_id": "<string>"
}
}Authorizations
bearerAuthapiKeyAuth
Dashboard access token. Send as Authorization: Bearer .
Path Parameters
Audience identifier within the authenticated organization.
Example:
"11111111-1111-4111-8111-111111111111"
Destination identifier belonging to the selected audience.
Example:
"22222222-2222-4222-8222-222222222222"
Body
application/json
Was this page helpful?