Skip to the content

Texa DeskDevelopers

Section

Texa Desk Application API · Inboxes

Add or remove agent bot

POST/api/v1/accounts/{account_id}/inboxes/{id}/set_agent_bot

To add an agent bot pass agent_bot id, to remove agent bot from an inbox pass null

Authorization

api_access_tokenheaderrequired

A person's access token (Texa Desk, Profile settings → Access token) or an agent bot's token, in the api_access_token header. It acts as that person, with their role's permissions.

Path parameters

account_idintegerrequired

The numeric ID of the account

idnumberrequired

ID of the inbox

Body application/json

agent_botnumberrequired

Agent bot ID

Responses

204

Success

404

Inbox not found, Agent bot not found

descriptionstring

errorsarray of object

errors[].fieldstring

errors[].messagestring

errors[].codestring

403

Access denied

descriptionstring

errorsarray of object

errors[].fieldstring

errors[].messagestring

errors[].codestring

curl -X POST 'https://desk.texadesk.com/api/v1/accounts/1/inboxes/1/set_agent_bot' \
  -H "api_access_token: $TEXA_DESK_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "agent_bot": 1
}'

import os, requests

headers = {"api_access_token": os.environ["TEXA_DESK_TOKEN"]}
body = {
    "agent_bot": 1
}
r = requests.post("https://desk.texadesk.com/api/v1/accounts/1/inboxes/1/set_agent_bot", headers=headers, json=body)
r.raise_for_status()
print(r.json())

const r = await fetch("https://desk.texadesk.com/api/v1/accounts/1/inboxes/1/set_agent_bot", {
  method: "POST",
  headers: { "api_access_token": `${process.env.TEXA_DESK_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({
    "agent_bot": 1
  }),
});
if (!r.ok) throw new Error(`${r.status}: ${await r.text()}`);
console.log(await r.json());