Push Audience

POST

/integrations/crm-sync/push

• Production
• QA

Push ONE audience rather than everything.

The narrow version of /contacts/push, and the one to reach for first: it bounds what lands in the customer’s CRM to a list they chose.

Authorizations

• BearerAuth

Parameters

Header Parameters

X-Target-Org-Id

Any of:

string

string

null

null

Request Body ^required

Push ONE audience, rather than everything.

object

audience_id

Any of:

integer

integer

null

null

chunk_size

Any of:

integer

integer

>= 1

null

null

connection_id

required

Which CRM connection to run against.

string

crm_list_id

Any of:

string

string

null

null

entity_type

Any of:

string

string

null

null

file_import_threshold

Any of:

integer

integer

null

null

limit

Any of:

integer

integer

>= 1

null

null

max_parallel

Any of:

integer

integer

>= 1

null

null

reconcile

Any of:

boolean

boolean

null

null

use_file_import

Any of:

boolean

boolean

null

null

Responses

202

Successful Response

object

data

required

A bulk job, or its status. Open-shaped - the payload carries per-provider progress detail that differs between CRMs and grows with them.

object

job_id

Any of:

string

string

null

null

status

Any of:

string

string

null

null

key

additional properties

any

pagination

Any of:

PaginationMeta

object

has_next

required

Whether there are more pages

boolean

limit

required

Items per page

integer

next_cursor

Any of:

string

string

null

null

page

required

Current page number (1-indexed)

integer

total

required

Total number of items

integer

null

null

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string