Change User Occupancy

📘

Supported Regions and Base URLs

👍

Access and Registration

Authentication

Scope

presence-occupancy:write

Request Body (Required)

[
  {
    "op": "add",
    "path": "interactions/-",
    "value": [
      {
        "id": "some_busy_state",
        "channel_name": "custom_busy",
        "cost": 100
      }
    ]
  },
  {
    "op": "test",
    "path": "/interactions/0/id",
    "value": "d290f1ee-6c54-4b01-90e6-d701748f0851"
  },
  {
    "op": "remove",
    "path": "/interactions/0"
  }
]

Body Response - Schema

400 (bad request), 403 (forbidden access), 404 (user not found), 422 (unprocessable entity)

ParameterTypeDescriptionRequired
codestringn/ayes
messagestringn/ayes
descriptionstringn/ano
fieldsarray[object]"fields" subdivides into:

"name" (string)

"description" (string)
yes (name and description)

❗️

API Availability

The Presence API is only available for customers enrolled in Talkdesk's Early Access (EA) program.
To enter the EA program, contact a Customer Success Manager.

🚧

Troubleshooting

If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.

Language
Click Try It! to start a request and see the response here!