Skip to main content
POST
Add Recipient

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. A key carries up to three permissions: public:read for GET requests, public:write for POST, PATCH, and PUT requests, and public:delete for DELETE requests. public:delete is only available together with public:write.

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

Path Parameters

id
string
required

Resource ID

Body

application/json
email
string
required

The recipient's email address.

fields
object

Optional values for this recipient, up to 50 keys with scalar values. Each is stored as a string of up to 1024 characters, can be used as a merge tag in the message (for example {first_name}), and appears in reports, exports and the contact.custom_fields of outbound webhooks.

occurrence_id
string

Your own id for the event that adds this person. Sending the same occurrence_id again is a no-op, so a retry cannot add or send twice.

Maximum string length: 128

Response

Nothing was added because this person or this occurrence_id was already entered; reason says which. A safe answer to a retry.

success
boolean
required
data
object
required

The outcome of adding one recipient.