Start a batch of operations

post

https://{hostname}/delivery-manager/v1/batch

This operation bundles other requests from this API into a single transaction and returns a combined response. You can use it to perform related operations efficiently, reducing network round trips.

Query Params

accountSwitchKey

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params

commands

array of objects

required

length ≥ 1

The sequence of operations to execute in batch. Each command represents a single API request, and the batch processes them in order. If any command fails, the batch rolls back all changes made by previous commands, ensuring the entire batch is treated as a single transaction.

commands*

commandName

string

required

A unique name for the command within the batch. You can reference the command's result in subsequent commands to chain operations together.

method

string

enum

required

The HTTP method for the command, indicating the type of operation to perform. Set this to POST to create resources, PUT to update resources, or DELETE to remove resources.

Allowed:

requestBody

object

The JSON payload for the command, required for POST and PUT methods. This body contains the data needed to create or update the resource as specified by the command's URL and method.

requestHeaders

array of objects

requestHeaders

url

string

required

Specifies the resource URL to target for the operation, relative to the API base path.

Response

Language

URL

Loading…

Response

Choose an example:

application/json

202The response shows that the batch job initiated. To check its status or view the results once it completes, GET the URL in the Location header.