Executes a batch action on content items by action name.

Behavior: Performs the specified batch action on the content items identified in the request body. The action name is provided in the route and is matched (case-insensitive) against the BatchActions enum. Common actions include Delete, Archive, Restore, Duplicate, Move, Copy, Index, Reprocess, AddTag, RemoveTag, AddCollection, and RemoveCollection. The "Asset Metadata" content definition is reserved and cannot be targeted by batch actions.

Authorization: Requires a valid Bearer token.

Side Effects: Modifies the targeted content items according to the specified action.

Error Scenarios: Returns 400 if the action name is not a valid BatchActions value, the request body is null, or the content definition is the reserved Asset Metadata definition.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The batch action to perform (case-insensitive, e.g., "delete", "archive", "addTag").

Body Params

The batch model containing target content IDs and action arguments.

batchAction
object | null
uuid | null
string | null
targetIds
array of uuids | null
targetIds
uuid
actionArguments
object | null

Note that we convert all incoming keys to lower first char to help with serialization for JSON later

boolean | null
Headers
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json