SIsigmacomputing
User attributes

Update a user attribute

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.
patch/v2/user-attributes/{userAttributeId}

Request

  • Base URL
    https://api.sigmacomputing.com
  • Auth
    HTTP bearer

Path parameters

userAttributeIdstring required

Unique identifier of the user attribute.

Request body

userAttributeNamestring

Name of the user attribute.

descriptionstring

Description of the user attribute.

Response

The response body.

userAttributeIdstring required

Unique identifier of the user attribute.

namestring required

Name of the user attribute.

createdBystring required

The identifier of the user who created this object.

updatedBystring required

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

createdAtstring date-time required

When the object was created.

updatedAtstring date-time required

When the object was last updated.

descriptionstring nullable

Description of the user attribute.

Changes

No recorded changes to this operation across all 1 revision of this API.