Skip to main content
POST
Import Contact List

Authorizations

X-API-Key
string
header
required

Authenticate every request by passing your API key in the X-API-Key header. Keys are scoped to your organization hierarchy.

Headers

Idempotency-Key
string

Optional idempotency key: a unique string of 16-200 printable ASCII characters (a UUID is recommended). Retrying the write with the same key within 24 hours returns the stored response of the first call with an X-Idempotent-Replayed: true response header instead of executing it again. Reusing a key with a different request body returns 422 (IDEMPOTENCY_MISMATCH); a duplicate sent while the first call is still running returns 409 with a Retry-After header. Keys are scoped per endpoint and organization.

Required string length: 16 - 200

Body

application/json
source_url
string<uri>
required
list_name
string
required
phone_column
string
required
organization_id
string

Target organization for the import. Defaults to the organization that owns the API key. Required only when targeting a sub-organization under an agency-tier parent; the API key must have access to the sub-organization (otherwise the request returns 403 ORG_ACCESS_DENIED).

brand_id
string

Optional. When provided, the list is scoped to this brand and the brand's organization is used (must match organization_id if both are sent, otherwise returns 400 BRAND_ORG_MISMATCH).

merge_tags
object

Response

Import accepted (poll the contact list for ready status)

success
boolean
required
data
object
required