Skip to main content
POST
Sync retarget audience

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
segment
enum<string>
required

Conversion funnel stage to build the audience from.

Available options:
conversations,
leads,
purchases
since
string<date-time>
required

ISO 8601 start of the date range (inclusive).

until
string<date-time>
required

ISO 8601 end of the date range (inclusive).

adAccountId
string
required

Meta ad account id (act_) to sync the audience to.

Minimum string length: 1
adId
string | null

Restrict to this ad id.

Minimum string length: 1
channel
enum<string>

Restrict to this channel.

Available options:
whatsapp,
facebook,
messenger,
instagram
integrationWhatsappId
string

Restrict to this WhatsApp integration.

integrationMessengerId
string

Restrict to this Messenger integration.

integrationInstagramId
string

Restrict to this Instagram integration.

audienceName
string

Name for a new custom audience. Provide this or customAudienceId, not both.

Minimum string length: 1
customAudienceId
string

Existing custom audience id to sync into. Provide this or audienceName, not both.

Minimum string length: 1

Response

OK

customAudienceId
string
required
enqueued
any
required