Manage contact identifiers

The following endpoints allow for managing the identifiers for a single contact.

List contact identifiers

GET/workspaces/{workspaceId}/contacts/{contactId}/identifiers

Path parameters

workspaceId*string

contactId*string

Response

Body

results*array of Identifier (object)

nextPageTokenstring

The token that can be passed as pageToken in URL to retrieve the next set of results. If missing, no more results to display.

Request

Response

Create contact identifier

POST/workspaces/{workspaceId}/contacts/{contactId}/identifiers

Path parameters

workspaceId*string

contactId*string

Body

key*string

value*string

Response

Created

Body

contactId*string (uuid)

key*string

value*string

createdAt*string (date-time)

Request

Response

Delete contact identifier

DELETE/workspaces/{workspaceId}/contacts/{contactId}/identifiers

Path parameters

workspaceId*string

contactId*string

Body

key*string

value*string

Response

Deleted

Request

Response

Last updated 5 months ago

const response = await fetch('/workspaces/{workspaceId}/contacts/{contactId}/identifiers', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "key": "text",
      "value": "text"
    }),
});
const data = await response.json();

{
  "results": [
    {
      "contactId": "123e4567-e89b-12d3-a456-426614174000",
      "key": "text",
      "value": "text",
      "createdAt": "2024-11-21T08:51:53.532Z"
    }
  ],
  "nextPageToken": "text"
}

const response = await fetch('/workspaces/{workspaceId}/contacts/{contactId}/identifiers', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "key": "text",
      "value": "text"
    }),
});
const data = await response.json();