Manage workspace contacts

The following endpoints allow for creating contacts and managing their life cycle.

List Contacts

Retrieve a list of all contacts

GET/workspaces/{workspaceId}/contacts

Path parameters

workspaceId*string

Query parameters

Response

200404

OK

Body

application/json

results*array of Contact (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

JavaScriptCurlPython

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

Response

200404

{
  "results": [
    {
      "id": "text",
      "computedDisplayName": "text",
      "createdAt": "2024-11-21T08:37:36.472Z",
      "updatedAt": "2024-11-21T08:37:36.472Z",
      "workspaceId": "text",
      "featuredIdentifiers": [
        {
          "key": "text",
          "value": "text"
        }
      ],
      "attributes": {
        "firstName": "John",
        "lastName": "Smith",
        "rating": 9.6,
        "cookiesAccepted": false,
        "labels": [
          "A",
          "B",
          "C"
        ]
      }
    }
  ],
  "nextPageToken": "text"
}

Create Contact

Create a new contact

POST/workspaces/{workspaceId}/contacts

Path parameters

workspaceId*string

Body

application/json

displayName*string

identifiersnullable array of CreateIdentifier (object)

Other propertiesany

Response

201404409422

Created

Body

application/json

id*string

computedDisplayNamestring

createdAt*string (date-time)

updatedAt*string (date-time)

workspaceIdstring

featuredIdentifiersarray of IdentifierRef

attributesnullable AttributesObject (object)

A map of key-value pairs, where the values are boolean, number, or string, or a non-empty array of those, or null

identifierCountinteger

Request

JavaScriptCurlPython

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

Response

201404409422

{
  "id": "text",
  "computedDisplayName": "text",
  "createdAt": "2024-11-21T08:37:36.472Z",
  "updatedAt": "2024-11-21T08:37:36.472Z",
  "workspaceId": "text",
  "featuredIdentifiers": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "attributes": {
    "firstName": "John",
    "lastName": "Smith",
    "rating": 9.6,
    "cookiesAccepted": false,
    "labels": [
      "A",
      "B",
      "C"
    ]
  }
}

Get Contact

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

Path parameters

workspaceId*string

contactId*string

Query parameters

Response

200404422

OK

Body

application/json

id*string

computedDisplayNamestring

createdAt*string (date-time)

updatedAt*string (date-time)

workspaceIdstring

featuredIdentifiersarray of IdentifierRef

attributesnullable AttributesObject (object)

A map of key-value pairs, where the values are boolean, number, or string, or a non-empty array of those, or null

identifierCountinteger

Request

JavaScriptCurlPython

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

Response

200404422

{
  "id": "text",
  "computedDisplayName": "text",
  "createdAt": "2024-11-21T08:37:36.472Z",
  "updatedAt": "2024-11-21T08:37:36.472Z",
  "workspaceId": "text",
  "featuredIdentifiers": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "attributes": {
    "firstName": "John",
    "lastName": "Smith",
    "rating": 9.6,
    "cookiesAccepted": false,
    "labels": [
      "A",
      "B",
      "C"
    ]
  }
}

Delete Contact

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

Path parameters

workspaceId*string

contactId*string

Query parameters

Response

204404

Deleted

Request

JavaScriptCurlPython

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

Response

404

{
  "code": "text",
  "message": "text"
}

Create or Update Contact by Identifier

PATCH/workspaces/{workspaceId}/contacts/identifiers/{identifierKey}/{identifierValue}

Path parameters

workspaceId*string

identifierKey*string

identifierValue*string

Body

application/json

identifiersnullable array of CreateIdentifier (object)

Other propertiesany

Response

200201404409422

Updated

Body

application/json

id*string

computedDisplayNamestring

createdAt*string (date-time)

updatedAt*string (date-time)

workspaceIdstring

featuredIdentifiersarray of IdentifierRef

attributesnullable AttributesObject (object)

A map of key-value pairs, where the values are boolean, number, or string, or a non-empty array of those, or null

identifierCountinteger

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/contacts/identifiers/{identifierKey}/{identifierValue}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200201404409422

{
  "id": "text",
  "computedDisplayName": "text",
  "createdAt": "2024-11-21T08:37:36.472Z",
  "updatedAt": "2024-11-21T08:37:36.472Z",
  "workspaceId": "text",
  "featuredIdentifiers": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "attributes": {
    "firstName": "John",
    "lastName": "Smith",
    "rating": 9.6,
    "cookiesAccepted": false,
    "labels": [
      "A",
      "B",
      "C"
    ]
  }
}

Get contact list memberships

Retrieve a list of lists a contact is a member of

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

Authorization

useraccessKey

Path parameters

workspaceId*string (uuid)

contactId*string

Response

200404

List of groups

Body

application/json

resultsarray of Group (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

JavaScriptCurlPython

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

Response

200404

{
  "results": [
    {
      "id": "text",
      "name": "Sample Group",
      "description": "text",
      "createdAt": "2024-11-21T08:37:36.472Z",
      "updatedAt": "2024-11-21T08:37:36.472Z",
      "consentType": "single",
      "tags": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "nextPageToken": "text"
}