Bevatel

Add New Custom Attribute

POST/v1/custom-attributes

Creates a custom attribute definition. key and type are immutable after creation.

Body

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]•Required when type is list
Example:[ "sales", "support" ]

Responses

Body

success_codeenum: 200 | 201•Numeric success code matching the HTTP response status. required
Example:200
messagestring required
Example:Custom attribute created
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