Delete confirmed agent

POST {{baseUrl}}/api/v1/agents/:agent_id/delete

This API deletes a confirmed agent from your help desk.

OAuth Scope

  • Desk.settings.DELETE
  • Desk.basic.DELETE

Attributes

Attribute NameData TypeDescription
anonymizedName<string>
max chars : 50
Nickname of the agent, which will appear on their entity history page
isAnonymize<boolean>
Key that determines if the deleted agent must be anonymized in the help desk

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring