Attribute definition

The following endpoints allow for managing the custom attribute schema for your contacts.

List Attribute Definitions

Retrieve a list of all attribute definitions in the schema

GET/workspaces/{workspaceId}/attribute-definitions

Path parameters

workspaceId*string

Query parameters

Response

200404

OK

Body

application/json

idstring

The UUID, primarily for internal reference

keystring

A user-specified key, primarily for client reference

displayNamestring

A user-friendly string to describe the meaning of this attribute

cardinalityenum

The cardinality configures how many values belong to the single key

onemany

typeenum

The data type of the attribute

booleandatetimenumberstring

piiboolean

A flag to indicate whether this attribute is considered personally identifiable information

readOnlyboolean

A flag to indicate whether this attribute may be updated after creation

builtinboolean

A flag to indicate whether this attribute is built-in. Built-in attributes are system-defined and cannot be updated or deleted by end-users

createdAtstring (date-time)

updatedAtstring (date-time)

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}/attribute-definitions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200404

{
  "id": "text",
  "key": "text",
  "displayName": "text",
  "cardinality": "one",
  "type": "boolean",
  "pii": false,
  "readOnly": false,
  "builtin": false,
  "createdAt": "2024-11-21T08:54:52.390Z",
  "updatedAt": "2024-11-21T08:54:52.390Z",
  "nextPageToken": "text"
}

Create Attribute Definition

Create a new attribute definition in the schema

POST/workspaces/{workspaceId}/attribute-definitions

Path parameters

workspaceId*string

Body

application/json

key*string

Pattern: ^[A-Za-z\d_-]{1,255}$

displayName*string

cardinality*enum

onemany

type*enum

booleandatetimenumberstring

pii*boolean

readOnly*boolean

Response

201404409422

Created

Body

application/json

idstring

The UUID, primarily for internal reference

keystring

A user-specified key, primarily for client reference

displayNamestring

A user-friendly string to describe the meaning of this attribute

cardinalityenum

The cardinality configures how many values belong to the single key

onemany

typeenum

The data type of the attribute

booleandatetimenumberstring

piiboolean

A flag to indicate whether this attribute is considered personally identifiable information

readOnlyboolean

A flag to indicate whether this attribute may be updated after creation

builtinboolean

A flag to indicate whether this attribute is built-in. Built-in attributes are system-defined and cannot be updated or deleted by end-users

createdAtstring (date-time)

updatedAtstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/attribute-definitions', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "key": "text",
      "displayName": "text",
      "cardinality": "one",
      "type": "boolean",
      "pii": false,
      "readOnly": false
    }),
});
const data = await response.json();

Response

201404409422

{
  "id": "text",
  "key": "text",
  "displayName": "text",
  "cardinality": "one",
  "type": "boolean",
  "pii": false,
  "readOnly": false,
  "builtin": false,
  "createdAt": "2024-11-21T08:54:52.390Z",
  "updatedAt": "2024-11-21T08:54:52.390Z"
}

Get Attribute Definitions

Get an attribute definitions from the schema by key

GET/workspaces/{workspaceId}/attribute-definitions/{attributeDefinitionKey}

Path parameters

workspaceId*string

attributeDefinitionKey*string

Response

200404

OK

Body

application/json

idstring

The UUID, primarily for internal reference

keystring

A user-specified key, primarily for client reference

displayNamestring

A user-friendly string to describe the meaning of this attribute

cardinalityenum

The cardinality configures how many values belong to the single key

onemany

typeenum

The data type of the attribute

booleandatetimenumberstring

piiboolean

A flag to indicate whether this attribute is considered personally identifiable information

readOnlyboolean

A flag to indicate whether this attribute may be updated after creation

builtinboolean

A flag to indicate whether this attribute is built-in. Built-in attributes are system-defined and cannot be updated or deleted by end-users

createdAtstring (date-time)

updatedAtstring (date-time)

Request

JavaScriptCurlPython

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

Response

200404

{
  "id": "text",
  "key": "text",
  "displayName": "text",
  "cardinality": "one",
  "type": "boolean",
  "pii": false,
  "readOnly": false,
  "builtin": false,
  "createdAt": "2024-11-21T08:54:52.390Z",
  "updatedAt": "2024-11-21T08:54:52.390Z"
}

Upsert Attributes

Upserts contact attributes

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

Path parameters

workspaceId*string

contactId*string

Body

application/json

Other propertiesany

Response

204404422

Upsert was successful

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/contacts/{contactId}/attributes', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "firstName": "John",
      "lastName": "Smith",
      "rating": 9.6,
      "cookiesAccepted": false,
      "labels": [
        "A",
        "B",
        "C"
      ]
    }),
});
const data = await response.json();

Response

404

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