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

JavaScriptCurl

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

Response

{
  "results": [
    {
      "id": "text",
      "computedDisplayName": "text",
      "createdAt": "2024-04-29T09:18:44.915Z",
      "updatedAt": "2024-04-29T09:18:44.915Z",
      "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

JavaScriptCurl

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

{
  "id": "text",
  "computedDisplayName": "text",
  "createdAt": "2024-04-29T09:18:44.915Z",
  "updatedAt": "2024-04-29T09:18:44.915Z",
  "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

JavaScriptCurl

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

Response

{
  "id": "text",
  "computedDisplayName": "text",
  "createdAt": "2024-04-29T09:18:44.915Z",
  "updatedAt": "2024-04-29T09:18:44.915Z",
  "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

JavaScriptCurl

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

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

JavaScriptCurl

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

{
  "id": "text",
  "computedDisplayName": "text",
  "createdAt": "2024-04-29T09:18:44.915Z",
  "updatedAt": "2024-04-29T09:18:44.915Z",
  "workspaceId": "text",
  "featuredIdentifiers": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "attributes": {
    "firstName": "John",
    "lastName": "Smith",
    "rating": 9.6,
    "cookiesAccepted": false,
    "labels": [
      "A",
      "B",
      "C"
    ]
  }
}