Delete Custom Attribute

API Details

Deletes a custom attribute of the brand. Without force, nothing is deleted while agents have a value for it, and the response lists them. With force=true, the value is removed from those agents, their Twilio workers are updated, and the attribute is deleted. Queues and routing rule sets are never changed. Once it is deleted, its name can be used again by a new custom attribute.

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.

Query Params
boolean
Defaults to false

When true, removes the value of the custom attribute from the agents that have it, updates their Twilio workers, and deletes the attribute even if agents have a value for it. Queues and routing rule sets are never changed. Defaults to false.

Responses

400

The value is neither an id (a UUID) nor a valid name (letters, digits and underscores).

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