Get early access

Custom agent status

Custom agent status: 5 operations of the ChaosDesk REST API.

Retrieves the collection of CustomAgentStatus resources.

GET/api/custom_agent_statuses

Responses

  • 200CustomAgentStatus collection
  • 403Forbidden

Example request

curl -X GET "https://yourcompany.chaosdesk.io/api/custom_agent_statuses" \
  -H "Authorization: Bearer $CHAOSDESK_TOKEN" \
  -H "Accept: application/json"

Creates a CustomAgentStatus resource.

POST/api/custom_agent_statuses

Request body application/json

namestringrequired
descriptionstring | null
base_status"online" | "away" | "offline"
What routing sees: only Online agents receive chats and auto-assigned tickets.
activeboolean
positioninteger

Responses

  • 201CustomAgentStatus resource created
  • 400Invalid input
  • 403Forbidden
  • 422An error occurred

Example request

curl -X POST "https://yourcompany.chaosdesk.io/api/custom_agent_statuses" \
  -H "Authorization: Bearer $CHAOSDESK_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"name":"string"}'

Retrieves a CustomAgentStatus resource.

GET/api/custom_agent_statuses/{id}

Parameters

idstringpathrequired
CustomAgentStatus identifier

Responses

  • 200CustomAgentStatus resource
  • 403Forbidden
  • 404Not found

Example request

curl -X GET "https://yourcompany.chaosdesk.io/api/custom_agent_statuses/{id}" \
  -H "Authorization: Bearer $CHAOSDESK_TOKEN" \
  -H "Accept: application/json"

Updates the CustomAgentStatus resource.

PATCH/api/custom_agent_statuses/{id}

Parameters

idstringpathrequired
CustomAgentStatus identifier

Request body application/merge-patch+json

namestring
descriptionstring | null
base_status"online" | "away" | "offline"
What routing sees: only Online agents receive chats and auto-assigned tickets.
activeboolean
positioninteger

Responses

  • 200CustomAgentStatus resource updated
  • 400Invalid input
  • 403Forbidden
  • 404Not found
  • 422An error occurred

Example request

curl -X PATCH "https://yourcompany.chaosdesk.io/api/custom_agent_statuses/{id}" \
  -H "Authorization: Bearer $CHAOSDESK_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/merge-patch+json" \
  -d '{"name":"string","description":"string"}'

Removes the CustomAgentStatus resource.

DELETE/api/custom_agent_statuses/{id}

Parameters

idstringpathrequired
CustomAgentStatus identifier

Responses

  • 204CustomAgentStatus resource deleted
  • 403Forbidden
  • 404Not found

Example request

curl -X DELETE "https://yourcompany.chaosdesk.io/api/custom_agent_statuses/{id}" \
  -H "Authorization: Bearer $CHAOSDESK_TOKEN" \
  -H "Accept: application/json"