Contacts
Manage Contact list and contact details Learn more.
Additional information about this section
- OBJECT
- POST
Creates a new contact. The request body must include a name, a phone number, or an email address. If all 3 of these parameters are missing, the contact won't ...
- GET
Retrieves a contact. Getting Merged Contacts When a source contact is merged with a target contact, the source contact is deleted. When calling Get Contact for ...
- GET
Retrieves a list of up to 1,000 contacts per request.
- POST
Retrieves a list of contacts, given the provided paging, filtering, and sorting. Up to 1,000 contacts can be returned per request. For a detailed list of ...
- PATCH
Updates a contact. Each time the contact is updated, revision increments by 1. The existing revision must be included when updating the contact. This ensures ...
- DELETE
Deletes a contact. Deleting a contact permanently removes them from the Contact List. If a contact is also a site member or site contributor, the contact ...
- POST
Updates the specified properties for multiple contacts. Fields that are included in fieldMask.paths are updated, while all other fields stay the same. To ...
- POST
Deletes multiple contacts. All contacts that meet the specified filter and search criteria are deleted. To perform a dry run, use the intended filter options ...
- GET
Lists facets from the site’s Contact List. Facets are labels and subscription statuses. Each facet returns its details (such as key and value), as well as ...
- POST
Retrieves facets from the site’s Contact List by filter. Facets are labels and subscription statuses. Each facet returns its details (such as key and value), ...
- POST
Adds and removes labels from multiple contacts. Labels are added to and removed from all contacts that meet the specified filter and search criteria. To ...
- POST
Adds labels to a contact. To create new labels: Use Find or Create Label. To find labels: Use Find or Create Label, Get Label, or List Labels.
- DELETE
Removes labels from a contact. If a label is no longer needed and you want to remove it from all contacts, you can delete it with Delete Label (in the Labels ...
- WEBHOOK
Triggered when a contact is created.
- WEBHOOK
Triggered when a contact is updated. If a contact is updated as part of a merge, the originatedFrom property is sent as merge. Otherwise, originatedFrom is ...
- WEBHOOK
Triggered when a contact is deleted. If a contact is deleted as part of a merge, the originatedFrom property is sent as merge. Otherwise, originatedFrom is ...
- WEBHOOK
Triggered when one or more source contacts are merged into a target contact. Merging contacts triggers these webhooks: Contact Merged is triggered. Contact ...
- OBJECT
Deprecation Notice > **The Contacts v1 API has been replaced with Contacts v4 and will be removed on March 31, 2022. If your app uses this endpoint, we ...
- WEBHOOK
Sent when a contact is created. Deprecation Notice > This webhook has been replaced with the Contact Created Webhook (Contacts v4) and will be removed on March ...
- WEBHOOK
Sent when a contact is updated. Deprecation Notice > This webhook has been replaced with the Contact Updated Webhook (Contacts v4) and will be removed on March ...
- WEBHOOK
Sent when a contact is deleted. Deprecation Notice > This webhook has been replaced with the Contact Deleted Webhook (Contacts v4) and will be removed on March ...
- OBJECT
- GET
Retrieves a bulk job. Bulk jobs are started with bulk operation endpoints in the Contacts API
- GET
Retrieves a list of bulk jobs. Up to 100 bulk jobs can be returned per request. Bulk jobs are started with bulk operation endpoints in the Contacts API