Update Custom Attribute

PUT/v1/custom-attributes/{id}

Updates display_name, description, and list_values. Key and type cannot be changed.

Path Parameters

idstring required

Custom attribute ULID

Example:text

Body

display_namestring required

Example:Department

description[ "string", "null" ]

list_valuesarray[string]•Required when attribute type is list

Example:[ "sales", "support", "engineering" ]

Responses

Body

success_codeenum: 200 | 201•Numeric success code matching the HTTP response status. required

Example:200

messagestring required

Example:Custom attribute updated

detailsobject required

dataobject (GeneralCustomAttribute) required

idstring (ulid) required

Example:01HXYZABCDEFGHJKLMNPQRSTUV

display_namestring required

Example:Department

description[ "string", "null" ]

Example:Contact department

keystring required

Example:department

typeenum: text | number | list required

Example:text

list_valuesarray[string]•Present when type is list

Example:[ "sales", "support" ]

created_atstring (date-time) required

updated_atstring (date-time) required

metaobject

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

Request Sample:Shell / cURL

1
2
3
4

curl --request PUT \
  --url "https://api-stg.bevatelcloud.com/v1/custom-attributes/{id}" \
  --header "Authorization: Bearer <YOUR_API_KEY>" \
  --header "Content-Type: application/json"

Response Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

{
  "success_code": 200,
  "message": "Custom attribute updated",
  "details": {},
  "data": {
    "id": "01HXYZABCDEFGHJKLMNPQRSTUV",
    "display_name": "Department",
    "key": "department",
    "type": "text",
    "list_values": [],
    "created_at": "2024-01-01T12:00:00Z",
    "updated_at": "2024-01-01T12:00:00Z"
  },
  "meta": {}
}