Reference

Contacts

Contacts are the workspace's recipients. A contact is identified by its email address, which never changes. Only create contacts who have consented to mailings (or where you have another legal basis): an active contact can be reached by mailings to distribution lists even if it is not on any list.

• GET/contactsList contactsThe contacts the key is allowed to see, in ID order, one page at a time.
• POST/contactsCreate contactA new contact in the workspace. If the address already exists, the response is 409 contact_exists.
• POST/contacts/upsertCreate or update contactCreates the contact if the address is new; otherwise it is updated. The usual call for an integration.
• POST/contacts/lookupLook up contacts by emailUp to 100 addresses in one call. The response has the contacts that exist (all statuses, including deleted).
• GET/contacts/{id}Get contactA contact with the lists it is on.
• PATCH/contacts/{id}Update contactChanges the fields you send. The email address cannot be changed.
• POST/contacts/{id}/unsubscribeUnsubscribe contactThe person does not want any more mailings: the contact leaves all lists, gets the status unsubscribed and the address is suppressed.
• POST/contacts/{id}/eraseErase contact (GDPR)Permanently erases the contact's personal data. The address is suppressed so that it never receives mailings again.