Applies one action to a list of agents: delete, archive, activate, or deactivate. The response summarizes how many were requested, succeeded, and failed, and gives a result for each ID.

When to use it

Use it to archive or clean up many agents in one call instead of sending one request per agent.

Required parameters

• action (body): the action to perform on the agents.
• ids (body): list of agent IDs to perform the action on.

Response

A successful call returns 200 OK with a BulkActionResponse: a summary with the requested, succeeded, and failed counts, and a results array with each ID, its status (success or failed), and any error code and message.

Related: Archive an agent, Delete an agent, Activate an agent, Deactivate an agent