v2

latestOpenAPI 3.1.0MIT2026-07-26105151330.5 KB

Contacts

Add Contact

Add a single contact. Requires API key with audience:write.

post/v1/contacts

Headers

Idempotency-Keystring

Optional key (max 100 chars) for safe retries. Same key + same body within 24h replays the original response (same status and body); same key + a different body returns 409 IDEMPOTENCY_CONFLICT. Scoped per API key.

Request body

emailstring email required

firstNamestring

lastNamestring

phonestring

Phone number (free-form, max 30 chars)

countrystring

languagestring

tagsstring[]

customFieldsobject

status'subscribed' | 'unsubscribed' | 'bounced' | 'non-subscribed'

Contact subscription status. Defaults to subscribed.

projectIdstring required

Response

Contact created

successboolean required

errorstring nullable