Sign in

v1

latestOpenAPI 3.0.22026-07-2441902.6 MB
Attributes API

Create a New Attribute

Creates a new routing attribute in the account. Use this endpoint to programmatically add attributes as part of a configuration workflow or integration with an external workforce management system. For team-scoped users, only teams within their scope can be associated with the attribute. The attribute name, active status, category, proficiency type, and default proficiency are required fields.

post/attributes

Request body

namestring required

The name of the attribute

category_idstring required

The id of the attributes category

activeboolean required

Boolean indicating if the attribute is active or not

proficiency'none' | 'five_stars_scale' required

The type of proficiency

default_proficiencyinteger required

Default value for proficiency

team_idsstring[]

The team IDs to associate with the attribute. For team-scoped users, this field is required and only teams within their scope are allowed.

Response

The created Attribute.

idstring required

The id of the attribute

namestring required

The name of the attribute

activeboolean required

Whether the attribute is active or inactive

category_idstring required

The id of the attribute category

category_namestring required

The name of the attribute category

proficiency'none' | 'five_stars_scale' required

The type of proficiency

default_proficiencyinteger required

The default value of the proficiency

users_countinteger required

The count of users associated to the attribute

flows_countinteger required

The count of flows using the attribute

team_idsstring[] required

The team IDs associated with the attribute. For team-scoped users, only teams within their scope are returned.

Example response

{
  "id": "123e4567-e89b-12d3-a456-426655440000",
  "name": "Attribute 1",
  "active": true,
  "category_id": "987e4567-jqw2-23b2-a456-122315440000",
  "category_name": "Category 1",
  "proficiency": "five_stars_scale",
  "default_proficiency": 60,
  "users_count": 10,
  "flows_count": 0,
  "team_ids": [
    "f3b8d0ea-d40d-417c-ac9c-0931e7fcb8aa"
  ],
  "_links": {
    "self": {
      "href": "http://api-docs.talkdesk.org/attributes/123e4567-e89b-12d3-a456-426655440000"
    },
    "attributes": {
      "href": "http://api-docs.talkdesk.org/attributes"
    }
  }
}