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

200404

OK

Body

application/json

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

JavaScriptCurl

const response = await fetch('/workspaces/{workspaceId}/contacts/{contactId}/identifiers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "results": [
    {
      "contactId": "123e4567-e89b-12d3-a456-426614174000",
      "key": "text",
      "value": "text",
      "createdAt": "2024-04-29T13:02:58.622Z"
    }
  ],
  "nextPageToken": "text"
}

Create contact identifier

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

Path parameters

workspaceId*string

contactId*string

Body

application/json

key*string

value*string

Response

201404409422

Created

Body

application/json

contactId*string (uuid)

key*string

value*string

createdAt*string (date-time)

Request

JavaScriptCurl

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();

Response

{
  "contactId": "123e4567-e89b-12d3-a456-426614174000",
  "key": "text",
  "value": "text",
  "createdAt": "2024-04-29T13:02:58.622Z"
}

Delete contact identifier

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

Path parameters

workspaceId*string

contactId*string

Body

application/json

key*string

value*string

Response

204404

Deleted

Request

JavaScriptCurl

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();