v5

OpenAPI 3.1.02026-08-037720751.3 KB

Attributes

Update an attribute

Updates a single attribute on a given object or list.

When target is objects, the required scopes are object_configuration:read-write. When target is lists, the required scopes are list_configuration:read-write.

patch/v2/{target}/{identifier}/attributes/{attribute}

Path parameters

target'objects' | 'lists' required

Whether the attribute is on an object or a list.

Example:lists

identifierstring required

A UUID or slug to identify the object or list the attribute belongs to.

Example:33ebdbe9-e529-47c9-b894-0ba25e9c15c0

attributestring required

A UUID or slug to identify the attribute.

Example:41252299-f8c7-4b5e-99c9-4ff8321d2f96

Request body

Example request

{
  "data": {
    "title": "Your Attribute",
    "description": "Lorem ipsum",
    "api_slug": "my-attribute",
    "is_required": true,
    "is_unique": true,
    "default_value": {
      "type": "dynamic",
      "template": "current-user"
    },
    "config": {
      "currency": {
        "default_currency_code": "USD",
        "display_type": "symbol"
      },
      "record_reference": {
        "allowed_objects": [
          "people"
        ]
      }
    }
  }
}

Response

Success

Example response

{
  "data": {
    "id": {
      "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",
      "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",
      "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96"
    },
    "title": "Company",
    "description": "A company attribute",
    "api_slug": "company",
    "type": "record-reference",
    "is_system_attribute": false,
    "is_writable": true,
    "is_required": false,
    "is_unique": false,
    "is_multiselect": false,
    "is_default_value_enabled": false,
    "is_archived": false,
    "default_value": null,
    "relationship": {
      "id": {
        "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",
        "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",
        "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96"
      },
      "object_slug": "companies",
      "title": "Team members",
      "api_slug": "team_members",
      "is_multiselect": true
    },
    "created_at": "2021-11-21T13:22:49.061Z",
    "config": {
      "currency": {
        "default_currency_code": null,
        "display_type": null
      },
      "record_reference": {
        "allowed_object_ids": [
          "companies"
        ]
      }
    }
  }
}