Contacts
Workspace behavior
workspace_id is optional. A standalone contact created without it is organization-scoped when Require Workspace ID is disabled and is rejected when that policy is enabled. If an initial channel account is supplied, omission inherits that account's authoritative workspace in either mode; account_id, platform, and identifier must be supplied together.
Endpoints
| Method | Endpoint | Description |
|---|---|---|
POST | Add a channel to a contact | Add a channel to a contact |
PUT | Add a contact to a static segment | Add a contact to a static segment |
POST | Bulk add tags, remove tags, or delete contacts | Bulk add tags, remove tags, or delete contacts |
POST | Bulk create up to 1000 contacts | Bulk create up to 1000 contacts |
DELETE | Clear a custom field value for a contact | Clear a custom field value for a contact |
POST | Create a contact | Create a contact |
DELETE | Delete a contact | Delete a contact |
GET | Get a single contact with all channels | Get a single contact with all channels |
GET | List channels for a contact | List channels for a contact |
GET | List immutable consent evidence for a contact | List immutable consent evidence for a contact |
GET | List all segment memberships for a contact | List all segment memberships for a contact |
GET | List contacts with filtering and pagination | List contacts with filtering and pagination |
POST | Merge another contact into this one | Merge another contact into this one |
POST | Record consent or withdrawal evidence | Record consent or withdrawal evidence |
DELETE | Remove a channel from a contact | Remove a channel from a contact |
DELETE | Remove a contact from a static segment | Remove a contact from a static segment |
PUT | Set a custom field value for a contact | Set a custom field value for a contact |
PATCH | Update a contact | Update a contact |
Found something wrong? Help us improve this page.