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.

post

/workspaces/{workspaceId}/attribute-definitions

Authorizations

MessageBird_userMessageBird_accessKey

Path parameters

workspaceIdstring · uuidrequired

Your workspace identifier.

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

Body

keystringrequired

A user-specified key, primarily for client reference.

Example: countryCode

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

displayNamestring · min: 1 · max: 150required

A human-readable name of the attribute.

Example: Country Code

descriptionstring · max: 500

A user-friendly description of the attribute.

Example: The country code of the contact

formatobject

piibooleanrequired

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

Example: false

readOnlybooleanrequired

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

Example: false

indexMappingobject

cardinalitystring · enumrequired

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

Options: one, many

typestring · enumrequired

Options: boolean, datetime, number, string

aclobject[]

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

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.bird.com/workspaces/{workspaceId}/attribute-definitions' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"key":"countryCode","displayName":"Country Code","description":"The country code of the contact","format":{"type":"emailAddress"},"pii":false,"readOnly":false,"indexMapping":{"fields":[{"name":"emailaddress-standard","analyzer":"simple","type":"string"}]},"cardinality":"one","type":"boolean","acl":[{"roleId":"123e4567-e89b-12d3-a456-426614174000","read":true,"write":true}]}'

201

404

409

422

201

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

The attribute definition was created successfully.

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"
        }
      ]
    }
  }
}