Skip to content

Create Audience Sync

POST
/audience-syncs

Create a new audience sync configuration.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

object
audience_id
required

Audience list ID

integer
> 0
mode

Sync mode: mirror | append_only

string
default: mirror
platform
required

Ad platform: meta | linkedin | google | x

string
platform_audience_name
Any of:
string
<= 255 characters
platform_config

Platform-specific config (OAuth creds)

object
key
additional properties
any
refresh_cadence_hours
integer
default: 24 <= 720
suppression_list_ids
Array<integer>

Responses

201

Successful Response

object
data
required
object
audience_id
required
integer
created_at
Any of:
string
id
required
integer
is_active
boolean
default: true
last_sync_at
Any of:
string
mode
string
default: mirror
platform
required
string
platform_audience_name
Any of:
string
refresh_cadence_hours
integer
default: 24
status
Any of:
string
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string