Update Attribute Definition

Update a user attribute definition's label.

Only label is mutable — name and data_type are fixed once created, because assigned values and data model references depend on them.

patch

/workspaces/{workspace_id}/user_attribute_definitions/{user_attribute_definition_id}

Authorizations

AuthorizationstringRequired

A Personal Access Token (PAT).

Path parameters

workspace_idstringRequired

user_attribute_definition_idstringRequired

Body

labelstringRequired

The human-facing display text for this definition; unlike name, this can be changed at any time.

Responses

200

Successful Response

application/json

4XX

Client Error

application/json

5XX

Server Error

application/json

patch/workspaces/{workspace_id}/user_attribute_definitions/{user_attribute_definition_id}

curl -L -X PATCH https://api-external.zenlytic.com/api/v2/workspaces/<workspace_id>/user_attribute_definitions/<user_attribute_definition_id> \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"label": "Sales Region"}'

{
  "data": {
    "id": "uad_123",
    "workspace_id": "ws_456",
    "name": "region",
    "data_type": "string",
    "label": "Sales Region"
  },
  "meta": {
    "status": "success",
    "errors": [],
    "warnings": []
  }
}