Skip to main content
PATCH
/
v1
/
batch-sessions
/
{batch_id}
Update Batch Session
curl --request PATCH \
  --url https://api.anchorbrowser.io/v1/batch-sessions/{batch_id} \
  --header 'Content-Type: application/json' \
  --header 'anchor-api-key: <api-key>' \
  --data '
{
  "status": "cancelled"
}
'
{
  "data": {
    "batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "cancelled",
    "cancelled_sessions": 123,
    "message": "<string>"
  }
}

Authorizations

anchor-api-key
string
header
required

API key passed in the header

Path Parameters

batch_id
string<uuid>
required

The unique identifier of the batch

Body

application/json
status
enum<string>
required

Target status for the batch

Available options:
cancelled

Response

Batch updated successfully

data
object