Update Custom Attribute

API Details

Replaces the description of a custom attribute: a description that is missing from the body is removed. The name and the data type cannot be changed, and a body that has them is rejected.

Rate Limit

Limit TypeValue
Requests per second10

If you exceed this limit, you will receive a 429 Rate Limit Exceeded response.

Path Params
string
required

Unique identifier (UUID) or name of the custom attribute (letters, digits and underscores). A UUID is read as the id.

Body Params
string | null

Description of the custom attribute. It replaces the current one, so omitting it, or sending null, removes the description.

Responses

400

Invalid body, for example one that has the name or the data type, which cannot be changed, or a value in the path that is neither an id (a UUID) nor a valid name.

403

The user is not a brand admin.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json