Skip to content

Pull Crm List

POST
/integrations/crm-sync/pull

Pull ONE CRM list rather than everything.

crm_list_id is REQUIRED - without it there is no list to pull, and defaulting to “everything” is the opposite of what a narrow endpoint is for.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Pull ONE CRM list, rather than everything.

object
auto_create_audience
Any of:
boolean
connection_id
required
string
crm_list_id
required

REQUIRED - the CRM list to pull.

string
enrich_from_graph8
Any of:
boolean
entity_type
Any of:
string
graph8_list_id
Any of:
integer
limit
Any of:
integer
>= 1
reconcile
Any of:
boolean

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
status
Any of:
string
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

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