Sign in
Subscribers

Create subscriber import

Queues an asynchronous full-record subscriber import of up to 5,000 contacts.

post/subscribers/imports

Request body

duplicateStrategy'skip' | 'merge' | 'overwrite'
fileNamestring
listIdsstring[]
enrollInSequencesboolean
defaultPhoneCountrystring
smsConsentboolean
optInMode'default' | 'confirmed' | 'double_opt_in'
idempotencyKeystring

Caller-owned key (1-255 characters, not blank) that makes retrying this request safe. The key is scoped to the request content - resending the same request returns the already-queued import with deduplicated true, while different content under the same key queues a new import. A blank key is rejected with 400.

Example request

{
  "subscribers": [
    {
      "createdAt": "2019-03-14T09:30:00Z"
    }
  ]
}

Response

Idempotency key replay - the original import is returned and nothing new is queued

successboolean
deduplicatedboolean
messagestring

Example response

{
  "success": true,
  "deduplicated": true
}

Changes