Agents

Archive or unarchive an agent

Changed on

Soft-archives the agent — it is excluded from listings and stops accepting calls, but all data is preserved and the operation is fully reversible.

Pass ?on=false to unarchive (restore) a previously archived agent.

409 is returned when:

  • The agent is already in the requested state ("Agent is already archived" / "Agent is already active")
  • The agent is linked to an active campaign ("Agent is associated with the [status] campaign "[name]". Complete or remove the campaign before archiving.")
delete/agent/{id}/archive

Request

  • Base URL
    https://api.smallest.ai/atoms/v1
  • URL
    https://api.smallest.ai/atoms/v1/agent/{id}/archive
  • Auth
    HTTP bearer

Path parameters

idstring required

Query parameters

on'true' | 'false'

"true" (default) — archive the agent. "false" — unarchive (restore) a previously archived agent.

Response

Agent archived or unarchived successfully

statusboolean

Example response

{
  "status": true
}

Changes

  • 49ce8525306eRevision changes
    • breaking

      the query request parameter on was restricted to a list of enum values

    • breaking

      for the query request parameter on, default value was changed from true to true

    • info

      added the new enum value false to the query request parameter on

    • info

      added the new enum value true to the query request parameter on

    • info

      for the query request parameter on, the type was generalized from boolean to string

  • 7131fe74f3cbRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the new optional query request parameter on

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status