Update a user attribute

PATCH

/v2/user-attributes/:userAttributeId

PATCH

/v2/user-attributes/:userAttributeId

$ curl -X PATCH https://api.sigmacomputing.com/v2/user-attributes/userAttributeId \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "description": "The user’s home department.",
>   "defaultValue": {
>     "type": "string",
>     "val": "engineering"
>   }
> }'

200Request Example

1 {
2   "userAttributeId": "e4b7c2a1-9d3f-4e6b-8a2c-5f1d9e3b7a4c",
3   "name": "department",
4   "createdBy": "qJ8VpXeRp3ZvNtLm6WkYbGjFcAoS9h",
5   "updatedBy": "qJ8VpXeRp3ZvNtLm6WkYbGjFcAoS9h",
6   "createdAt": "2026-08-20T16:45:00.000Z",
7   "updatedAt": "2026-08-20T17:12:00.000Z",
8   "description": "The user’s home department.",
9   "defaultValue": {
10     "type": "string",
11     "val": "engineering"
12   }
13 }

Update the name, description, or default value of a user attribute. Only the fields included in the request are changed.

Usage notes

Retrieve the userAttributeId by calling the /v2/user-attributes endpoint.
Sigma-managed user attributes, such as /home_page/ cannot be renamed.

Update the name, description, or default value of a user attribute. Only the fields included in the request are changed. ### Usage notes - Retrieve the **userAttributeId** by calling the [/v2/user-attributes](https://help.sigmacomputing.com/reference/list-user-attributes) endpoint. - Sigma-managed user attributes, such as /`home_page/` cannot be renamed.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

userAttributeIdstringRequired

Unique identifier of the user attribute.

Request

The request body.

userAttributeNamestringOptional

Name of the user attribute.

descriptionstringOptional

Description of the user attribute.

defaultValueobject or nullOptional

Default value of the user attribute. Pass null to clear the current default value.

Response

The response body.

userAttributeIdstring

Unique identifier of the user attribute.

namestring

Name of the user attribute.

createdBystring

The identifier of the user who created this object.

updatedBystring

The identifier of the user or process that last updated this object.

createdAtdatetime

When the object was created.

updatedAtdatetime

When the object was last updated.

descriptionstring or nullOptional

Description of the user attribute.

defaultValueobject or nullOptional

Default value of the user attribute.