Contacts

Create or update a contact

POST/v1/contactsrequires contact:write

Matches on email within your organization: an existing contact is updated, otherwise one is created.

Requestcurl -X POST https://api.transmit.dev/v1/contacts \
  -H "Authorization: Bearer tr_v2_…" \
  -H "Content-Type: application/json" \
  -d '{
       "email": "hello@yourdomain.com"
     }'

Body

FieldTypeNotes
email requiredstringemail
first_namestring or null
last_namestring or null
phonestring or null
subscribedboolean
tagsstring[]at most 100
custom_fieldsobject

Responses

StatusMeaning
200The stored contact
401The API key is missing, malformed, expired or revoked
403The API key lacks the contact:write scope
422The request failed validation

Every response body is described in the OpenAPI spec, which this page is generated from.