Ads
Sync retarget audience
Queues an async sync of a retargeting audience to the ad platform. Returns immediately; the sync runs in the background.
POST
/
v1
/
ads
/
retarget-audiences
Sync retarget audience
curl --request POST \
--url https://app.chatbotx.io/api/v1/ads/retarget-audiences \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"since": "2023-11-07T05:31:56Z",
"until": "2023-11-07T05:31:56Z",
"adAccountId": "<string>",
"adId": "<string>",
"integrationWhatsappId": "<string>",
"integrationMessengerId": "<string>",
"integrationInstagramId": "<string>",
"audienceName": "<string>",
"customAudienceId": "<string>"
}
'import requests
url = "https://app.chatbotx.io/api/v1/ads/retarget-audiences"
payload = {
"since": "2023-11-07T05:31:56Z",
"until": "2023-11-07T05:31:56Z",
"adAccountId": "<string>",
"adId": "<string>",
"integrationWhatsappId": "<string>",
"integrationMessengerId": "<string>",
"integrationInstagramId": "<string>",
"audienceName": "<string>",
"customAudienceId": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
since: '2023-11-07T05:31:56Z',
until: '2023-11-07T05:31:56Z',
adAccountId: '<string>',
adId: '<string>',
integrationWhatsappId: '<string>',
integrationMessengerId: '<string>',
integrationInstagramId: '<string>',
audienceName: '<string>',
customAudienceId: '<string>'
})
};
fetch('https://app.chatbotx.io/api/v1/ads/retarget-audiences', 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://app.chatbotx.io/api/v1/ads/retarget-audiences",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'since' => '2023-11-07T05:31:56Z',
'until' => '2023-11-07T05:31:56Z',
'adAccountId' => '<string>',
'adId' => '<string>',
'integrationWhatsappId' => '<string>',
'integrationMessengerId' => '<string>',
'integrationInstagramId' => '<string>',
'audienceName' => '<string>',
'customAudienceId' => '<string>'
]),
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://app.chatbotx.io/api/v1/ads/retarget-audiences"
payload := strings.NewReader("{\n \"since\": \"2023-11-07T05:31:56Z\",\n \"until\": \"2023-11-07T05:31:56Z\",\n \"adAccountId\": \"<string>\",\n \"adId\": \"<string>\",\n \"integrationWhatsappId\": \"<string>\",\n \"integrationMessengerId\": \"<string>\",\n \"integrationInstagramId\": \"<string>\",\n \"audienceName\": \"<string>\",\n \"customAudienceId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://app.chatbotx.io/api/v1/ads/retarget-audiences")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"since\": \"2023-11-07T05:31:56Z\",\n \"until\": \"2023-11-07T05:31:56Z\",\n \"adAccountId\": \"<string>\",\n \"adId\": \"<string>\",\n \"integrationWhatsappId\": \"<string>\",\n \"integrationMessengerId\": \"<string>\",\n \"integrationInstagramId\": \"<string>\",\n \"audienceName\": \"<string>\",\n \"customAudienceId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.chatbotx.io/api/v1/ads/retarget-audiences")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"since\": \"2023-11-07T05:31:56Z\",\n \"until\": \"2023-11-07T05:31:56Z\",\n \"adAccountId\": \"<string>\",\n \"adId\": \"<string>\",\n \"integrationWhatsappId\": \"<string>\",\n \"integrationMessengerId\": \"<string>\",\n \"integrationInstagramId\": \"<string>\",\n \"audienceName\": \"<string>\",\n \"customAudienceId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"customAudienceId": "<string>",
"enqueued": true
}{
"defined": true,
"code": "businessError",
"status": 400,
"message": "An error occurred while processing your request",
"data": "<unknown>"
}{
"defined": true,
"code": "UNAUTHORIZED",
"status": 401,
"message": "Authentication required",
"data": "<unknown>"
}{
"defined": true,
"code": "FORBIDDEN",
"status": 403,
"message": "You do not have permission to perform this action",
"data": "<unknown>"
}{
"defined": true,
"code": "invalidRequestData",
"status": 422,
"message": "Input validation failed",
"data": {
"issues": [
{
"message": "<string>",
"path": [
"<string>"
]
}
]
}
}{
"defined": true,
"code": "tooManyRequests",
"status": 429,
"message": "Too many requests",
"data": "<unknown>"
}{
"defined": true,
"code": "INTERNAL_SERVER_ERROR",
"status": 500,
"message": "An unexpected error occurred",
"data": "<unknown>"
}Authorizations
bearerAuthdeveloperAccessTokentokenInSearchParams
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Conversion funnel stage to build the audience from.
Available options:
conversations, leads, purchases ISO 8601 start of the date range (inclusive).
ISO 8601 end of the date range (inclusive).
Meta ad account id (act_) to sync the audience to.
Minimum string length:
1Restrict to this ad id.
Minimum string length:
1Restrict to this channel.
Available options:
whatsapp, facebook, messenger, instagram Restrict to this WhatsApp integration.
Restrict to this Messenger integration.
Restrict to this Instagram integration.
Name for a new custom audience. Provide this or customAudienceId, not both.
Minimum string length:
1Existing custom audience id to sync into. Provide this or audienceName, not both.
Minimum string length:
1Was this page helpful?
⌘I
Sync retarget audience
curl --request POST \
--url https://app.chatbotx.io/api/v1/ads/retarget-audiences \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"since": "2023-11-07T05:31:56Z",
"until": "2023-11-07T05:31:56Z",
"adAccountId": "<string>",
"adId": "<string>",
"integrationWhatsappId": "<string>",
"integrationMessengerId": "<string>",
"integrationInstagramId": "<string>",
"audienceName": "<string>",
"customAudienceId": "<string>"
}
'import requests
url = "https://app.chatbotx.io/api/v1/ads/retarget-audiences"
payload = {
"since": "2023-11-07T05:31:56Z",
"until": "2023-11-07T05:31:56Z",
"adAccountId": "<string>",
"adId": "<string>",
"integrationWhatsappId": "<string>",
"integrationMessengerId": "<string>",
"integrationInstagramId": "<string>",
"audienceName": "<string>",
"customAudienceId": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
since: '2023-11-07T05:31:56Z',
until: '2023-11-07T05:31:56Z',
adAccountId: '<string>',
adId: '<string>',
integrationWhatsappId: '<string>',
integrationMessengerId: '<string>',
integrationInstagramId: '<string>',
audienceName: '<string>',
customAudienceId: '<string>'
})
};
fetch('https://app.chatbotx.io/api/v1/ads/retarget-audiences', 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://app.chatbotx.io/api/v1/ads/retarget-audiences",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'since' => '2023-11-07T05:31:56Z',
'until' => '2023-11-07T05:31:56Z',
'adAccountId' => '<string>',
'adId' => '<string>',
'integrationWhatsappId' => '<string>',
'integrationMessengerId' => '<string>',
'integrationInstagramId' => '<string>',
'audienceName' => '<string>',
'customAudienceId' => '<string>'
]),
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://app.chatbotx.io/api/v1/ads/retarget-audiences"
payload := strings.NewReader("{\n \"since\": \"2023-11-07T05:31:56Z\",\n \"until\": \"2023-11-07T05:31:56Z\",\n \"adAccountId\": \"<string>\",\n \"adId\": \"<string>\",\n \"integrationWhatsappId\": \"<string>\",\n \"integrationMessengerId\": \"<string>\",\n \"integrationInstagramId\": \"<string>\",\n \"audienceName\": \"<string>\",\n \"customAudienceId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://app.chatbotx.io/api/v1/ads/retarget-audiences")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"since\": \"2023-11-07T05:31:56Z\",\n \"until\": \"2023-11-07T05:31:56Z\",\n \"adAccountId\": \"<string>\",\n \"adId\": \"<string>\",\n \"integrationWhatsappId\": \"<string>\",\n \"integrationMessengerId\": \"<string>\",\n \"integrationInstagramId\": \"<string>\",\n \"audienceName\": \"<string>\",\n \"customAudienceId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.chatbotx.io/api/v1/ads/retarget-audiences")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"since\": \"2023-11-07T05:31:56Z\",\n \"until\": \"2023-11-07T05:31:56Z\",\n \"adAccountId\": \"<string>\",\n \"adId\": \"<string>\",\n \"integrationWhatsappId\": \"<string>\",\n \"integrationMessengerId\": \"<string>\",\n \"integrationInstagramId\": \"<string>\",\n \"audienceName\": \"<string>\",\n \"customAudienceId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"customAudienceId": "<string>",
"enqueued": true
}{
"defined": true,
"code": "businessError",
"status": 400,
"message": "An error occurred while processing your request",
"data": "<unknown>"
}{
"defined": true,
"code": "UNAUTHORIZED",
"status": 401,
"message": "Authentication required",
"data": "<unknown>"
}{
"defined": true,
"code": "FORBIDDEN",
"status": 403,
"message": "You do not have permission to perform this action",
"data": "<unknown>"
}{
"defined": true,
"code": "invalidRequestData",
"status": 422,
"message": "Input validation failed",
"data": {
"issues": [
{
"message": "<string>",
"path": [
"<string>"
]
}
]
}
}{
"defined": true,
"code": "tooManyRequests",
"status": 429,
"message": "Too many requests",
"data": "<unknown>"
}{
"defined": true,
"code": "INTERNAL_SERVER_ERROR",
"status": 500,
"message": "An unexpected error occurred",
"data": "<unknown>"
}