Contacts API
Add, update, upsert and remove contacts, one at a time or up to 1,000 at once.
- GETList contacts
/v1/contactBooks/{contactBookId}/contactsList the contacts in a contact book, paged by the query parameters.
- POSTAdd a contact
/v1/contactBooks/{contactBookId}/contactsAdd one contact to a contact book.
- GETGet a contact
/v1/contactBooks/{contactBookId}/contacts/{contactId}Retrieve one contact.
- PATCHUpdate a contact
/v1/contactBooks/{contactBookId}/contacts/{contactId}Change the fields you send on an existing contact.
- PUTUpsert a contact
/v1/contactBooks/{contactBookId}/contacts/{contactId}Create the contact if it does not exist, or update it if it does.
- DELDelete a contact
/v1/contactBooks/{contactBookId}/contacts/{contactId}Remove one contact from a contact book.
- POSTAdd contacts in bulk
/v1/contactBooks/{contactBookId}/contacts/bulkAdd up to 1,000 contacts to a contact book in one request.
- DELDelete contacts in bulk
/v1/contactBooks/{contactBookId}/contacts/bulkRemove up to 1,000 contacts from a contact book in one request.
- GETList suppressed addresses
/v1/suppressionsPage through the team's suppression list, newest first: the addresses Notix will not send to, with the reason (HARD_BOUNCE, COMPLAINT, MANUAL or…
- GETCheck addresses against the suppression list
/v1/suppressions/checkFor up to 100 comma-separated addresses, whether each is on the suppression list, why, and for a SOFT_BOUNCE_REPEATED entry when it lifts (expiresAt).
- GETGet suppression and unsubscribe trends
/v1/suppressions/trendsHow the suppression list grew over the last 30 UTC days, the same figures as the Suppressions page: addresses added each day by reason, people who…
- POSTSuppress addresses
/v1/suppressionsAdd up to 100 addresses to the team's suppression list as MANUAL entries.
- DELLift a manual suppression
/v1/suppressions/{email}Remove an address this API key suppressed, or a SOFT_BOUNCE_REPEATED entry.
- POSTImport contacts from CSV
/v1/contactBooks/{contactBookId}/contacts/importImport up to 1,000 contacts from CSV text (at most 1,000,000 bytes) into a contact book.