Skip to main content
POST
Create 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
name
string
required
Required string length: 1 - 255
organization_id
string<uuid>

Create the list in this organization (one your key can reach). Defaults to the key's organization.

description
string
Maximum string length: 2000
email_domain_id
string<uuid>

Scopes the list to one sending domain. Omit for an organization-wide list any campaign can use.

acquired
boolean

Set this when the list came from somewhere other than your own sign-up flow. Acquired lists ramp on half the normal warm-up steps.

Optional. Where the email addresses came from. Allowed only when purpose is audience and email_column is set; sent with any other combination it returns 400. Omit it and no consent record is stored.

Response

List created. The same object GET /contact-lists/{id} returns.

success
boolean
required
data
object
required