Create attribute definition

Create attribute definition

This endpoint is used to create a new attribute definition for all contacts in a workspace. A contact attribute definition is used to define the attributes that a contact can have.

POSThttps://api.bird.com/workspaces/{workspaceId}/attribute-definitions

Path parameters

workspaceId*string (uuid)

Your workspace identifier.

Example: "b4e02c85-c6d2-4b15-8885-e09671799c61"

Body

application/json

key*string

A user-specified key, primarily for client reference.

Example: "countryCode"

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

displayName*string

A human-readable name of the attribute.

Example: "Country Code"

descriptionstring

A user-friendly description of the attribute.

Example: "The country code of the contact"

cardinality*enum

The cardinality configures how many values belong to the single key.

onemany

type*enum

booleandatetimenumberstring

formatContacts_AttributeFormat (object)

emailAddressphoneNumberselectuuidtexturldatenumberScale

pii*boolean

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

Example: false

readOnly*boolean

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

Example: false

indexMappingContacts_AttributeIndexMapping (object)

aclarray of Contacts_AttributeDefinitionAcl (object)

An array of ACLs that define the access control for this attribute

Response

201404409422

The attribute definition was created successfully.

Body

application/json

idstring

The UUID, primarily for internal reference

Example: "123e4567-e89b-12d3-a456-426614174000"

keystring

A user-specified key, primarily for client reference.

Example: "countryCode"

displayNamestring

A human-readable name of the attribute.

Example: "Country Code"

descriptionstring

A user-friendly description of the attribute.

Example: "The country code of the contact."

cardinalityenum

The cardinality configures how many values belong to the single key.

onemany

typeenum

The data type of the attribute.

booleandatetimenumberstring

formatContacts_AttributeFormat (object)

emailAddressphoneNumberselectuuidtexturldatenumberScale

piiboolean

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

Example: false

readOnlyboolean

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

Example: false

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.

Example: false

archivedboolean

A flag to indicate whether this attribute is archived.

Example: false

indexMappingContacts_AttributeIndexMapping (object)

createdAtstring (date-time)

updatedAtstring (date-time)

versionnumber

The version number of the attribute definition.

Example: 1

aclarray of Contacts_AttributeDefinitionAcl (object)

An array of ACLs that define the access control for this attribute

Request

JavaScriptCurlPython

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

Response

201404409422

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "key": "countryCode",
  "displayName": "Country Code",
  "description": "The country code of the contact.",
  "cardinality": "one",
  "type": "boolean",
  "format": {
    "type": "emailAddress"
  },
  "pii": false,
  "readOnly": false,
  "builtin": false,
  "archived": false,
  "indexMapping": {
    "fields": [
      {
        "name": "emailaddress-standard",
        "analyzer": "simple",
        "type": "string"
      }
    ]
  },
  "createdAt": "2024-12-21T15:50:55.550Z",
  "updatedAt": "2024-12-21T15:50:55.550Z",
  "version": 1,
  "acl": [
    {
      "roleId": "123e4567-e89b-12d3-a456-426614174000",
      "read": true,
      "write": true
    }
  ]
}

Examples

Let's establish some of our data that will be used in the following examples:

• Workspace ID: a1405560-c8d3-4b1a-877d-3f449ad95352

• AccessKey: abcd

Create an attribute definition

In this example, we're creating a basic attribute definition.

Request

curl -X POST "https://api.bird.com/workspaces/a1405560-c8d3-4b1a-877d-3f449ad95352/attribute-definitions" \
-H "Content-Type: application/json" \
-H "Authorization: AccessKey abcd" \
-d '{
  "type": "string",
  "key": "countryCode",
  "displayName": "countryCode", 
  "description": "Country code",
  "pii": false,
  "cardinality": "one",
  "readOnly": false
}'

Response (200 OK)

{
  "key": "countryCode",
  "displayName": "countryCode",
  "description": "Country code",
  "cardinality": "one",
  "type": "string",
  "pii": false,
  "readOnly": false,
  "builtin": false,
  "archived": false,
  "createdAt": "2024-11-26T15:00:00.000Z",
  "updatedAt": "2024-11-26T15:00:00.000Z",
  "group": "custom"
}

Create an attribute definition with a format

In this example, we're creating an attribute definition and prodivding a format in order to validate the value.

Request

curl -X POST "https://api.bird.com/workspaces/a1405560-c8d3-4b1a-877d-3f449ad95352/attribute-definitions" \
-H "Content-Type: application/json" \
-H "Authorization: AccessKey abcd" \
-d '{
  "type": "string",
  "key": "countryCode",
  "displayName": "countryCode", 
  "description": "Country code",
  "pii": false,
  "cardinality": "one",
  "readOnly": false
  "format": {
    "type": "select",
    "select": {
      "options": [
        {
          "label": "US",
          "value": "US"
        },
        {
          "label": "BR", 
          "value": "BR"
        }
      ]
    }
  }
}'

Response (200 OK)

{
  "key": "countryCode",
  "displayName": "countryCode",
  "description": "Country code",
  "cardinality": "one",
  "type": "string",
  "pii": false,
  "readOnly": false,
  "builtin": false,
  "archived": false,
  "createdAt": "2024-11-26T15:00:00.000Z",
  "updatedAt": "2024-11-26T15:00:00.000Z",
  "group": "custom",
  "format": {
    "type": "select",
    "select": {
      "options": [
        {
          "label": "US",
          "value": "US"
        },
        {
          "label": "BR", 
          "value": "BR"
        }
      ]
    }
  }
}