Skip to the content

Texa DeskDevelopers

Section

Texa Desk Application API · Agents

Remove an Agent from Account

DELETE/api/v1/accounts/{account_id}/agents/{id}

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

idintegerrequired

The ID of the agent to be deleted.

Responses

200

Success

404

Agent 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 DELETE 'https://desk.texadesk.com/api/v1/accounts/1/agents/1' \
  -H "api_access_token: $TEXA_DESK_TOKEN"

import os, requests

headers = {"api_access_token": os.environ["TEXA_DESK_TOKEN"]}
r = requests.delete("https://desk.texadesk.com/api/v1/accounts/1/agents/1", headers=headers)
r.raise_for_status()

const r = await fetch("https://desk.texadesk.com/api/v1/accounts/1/agents/1", {
  method: "DELETE",
  headers: { "api_access_token": `${process.env.TEXA_DESK_TOKEN}` },
});
if (!r.ok) throw new Error(`${r.status}: ${await r.text()}`);