Agents

Archive an agent

Requires scope: manage. Soft-deletes the agent (sets status to archived). The address is retained and cannot be reused, and archiving cannot be undone. The agent sends nothing more; mail that reaches it is still received, stored and sent to your webhooks as before, so none is lost. A pause by our abuse-prevention system or for the agent's bounce or complaint rate stays as its pause_reason; one for the workspace's bounce or complaint rate stays until the hourly check finds that rate recovered, and then reads archived_via_api. A test key cannot archive an agent that has a live key tied to it, live mail (sent, scheduled or received) or a draft a live key made (403 live_mode_required).

delete/v1/agents/{id}

Request

  • Base URL: https://api.mails.ai
  • URL: https://api.mails.ai/v1/agents/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Agent id or name.

Response

The archived agent.

idstring required

Id of the archived agent (agt_…), also when the path named it by name.

status'archived' required

Always archived. The agent's address stays taken and cannot be given to a new agent.

archived_atstring date-time required

The time of this call. It is not kept on the agent, so archiving an archived agent again returns a new time.

Changes

No recorded changes to this operation across all 1 revision of this API.