Skip to main content
POST
Execute action batch

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request body schema.

action
Action · object
required

Action to execute.

records
Records · object[]
required

Records to process.

webhookUrl
string<uri>

URL to call when the batch completes.

webhookSecret
string

Secret used to sign webhook deliveries. When provided, Cargo includes an X-Cargo-Signature header (sha256=) so you can verify the payload.

Response

Successful response

batch
Batch · object
required

Created batch details.