Contacts

Create or update a contact

Idempotent on the email address. attributes is merged into whatever is already stored, so a partial sync never wipes state you set earlier. Setting status to unsubscribed records a marketing opt-out and emits the contact.unsubscribed webhook; transactional mail is unaffected.

post/contacts

Request

  • Base URL: https://api.supersendtx.com
  • URL: https://api.supersendtx.com/contacts
  • Auth: HTTP bearer

Request body

emailstring email required
external_idstring nullable
first_namestring nullable
last_namestring nullable
attributesobject nullable

Merged into existing attributes. Send null to clear them.

status'subscribed' | 'unsubscribed' | 'bounced' | 'complained'

Derived on read. A contact who is suppressed, or who has opted out of newsletter mail, always reads back as unsubscribed — there is one source of truth for consent and this reflects it.

source'api' | 'import' | 'dashboard' | 'agent' | 'on_site'

Where the contact was first created. on_site means an on-site message on your website captured the address.

Response

Contact created or updated

Changes

No recorded changes to this operation across all 1 revision of this API.