Skip to main content
POST

Authorizations

x-api-key
string
header
required

Organization API key. Get it from the 11x team or from the platform.

Headers

Idempotency-Key
string

Optional, max 255 characters after trimming. When supplied, its value is returned as batchId; otherwise 11x generates a UUID. Only a 202 records the key, for 24 hours. Within that time, a request with the same key and a byte-for-byte identical body returns the stored 202 response with the Idempotent-Replayed: true header and schedules nothing again; the same key with a different body returns 422 IDEMPOTENCY_KEY_REUSED. While the first request with a key is still being processed, another request with that key returns 409 IDEMPOTENCY_KEY_IN_PROGRESS. If the first request with a key does not return 202, nothing is recorded and the key can be reused for a corrected request. Use a new key for each new batch.

X-HMAC-Timestamp
string

Required when request signing is enabled for this agent. Current Unix time in seconds, within the agent's configured tolerance (default ±300 seconds).

Pattern: ^\d{1,10}$
X-HMAC-Signature
string

Required when request signing is enabled for this agent. Base64-encoded HMAC-SHA256 of POST + newline + timestamp + newline + the exact JSON body, using the agent's signing secret. The x-api-key header is also required.

Path Parameters

agentId
string
required

ID of the agent, e.g. agent.abc123.

Body

application/json
contacts
object[]
required

Contacts to enroll (1–1,000).

Required array length: 1 - 1000 elements
timezone
string

Default IANA timezone applied to contacts that don't supply their own. If omitted, falls back to the agent's first configured timezone.

Example:

"America/New_York"

groupByField
string

Group contacts by the value of a custom variable for contact chaining. Only the first valid contact per group is scheduled immediately. Cannot be combined with allowDuplicates.

Example:

"account_id"

normalizeFields
string[]

Custom variable names to title-case before scheduling (e.g. "JOHN" → "John"). Only applied for organizations in the normalization allowlist.

allowDuplicates
boolean
default:false

Bypass duplicate checks within the batch and against sequences on this agent that are still in progress or started within the past 30 days. Opt-outs and California calling restrictions still apply. Cannot be combined with groupByField.

Response

Accepted contacts were queued for asynchronous processing. Both full and partial acceptance return 202. Inspect rejected[] and do not assume sequence creation has completed.

batchId
string
required

Request correlation identifier: the trimmed Idempotency-Key when supplied, otherwise a generated UUID. This identifier is not a sequence ID.

Example:

"550e8400-e29b-41d4-a716-446655440000"

total
integer
required

Total contacts submitted.

Required range: 1 <= x <= 1000
Example:

2

accepted
integer
required

Contacts that passed upfront checks and were queued for background scheduling. Background creation can still fail.

Required range: 1 <= x <= 1000
Example:

2

rejected
object[]
required

Per-contact validation failures (empty when all passed).