Skip to main content
PUT
Upsert Recipients
Adds or updates up to 1000 recipients per request. This is the endpoint a signup hook, nightly job or Zapier/n8n flow should call: sending the same payload twice is harmless, and sending a changed one updates the contact in place. See the sync guide for end-to-end recipes. How each entry is matched and what happens: name and external_id are only written when you send them. attributes replaces the stored map when present. Upsert never deletes: remove departed users with Remove Recipient.

Authentication

This endpoint requires an API token passed as a Bearer token in the Authorization header.

Path Parameters

string
required
The mailing list’s unique identifier (UUID).

Body

(string | object)[]
required
1–1000 entries. A plain string is an email address. An object has:

Request

Response

integer
required
New recipients created
integer
required
Existing active recipients whose fields changed
integer
required
Removed recipients put back on the list
integer
required
Entries that matched an active recipient with identical fields
integer
required
Entries that matched a recipient who unsubscribed; nothing was changed
string[]
required
Entries whose email failed validation
object[]
required
Entries that could not be applied, each with email, external_id and a reason.
200

Errors

Rate Limits

This endpoint is limited to 30 requests per minute per IP.