Push a batch · BeaconBox docs

Request

curl -X POST https://api.beaconbox.eu/api/v1/messages/batch \
  -H "Authorization: Bearer $BEACONBOX_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 8f2b1c04-3d6a-4e55-9a12-77c0b4e9d100" \
  -d '{
       "items": [
         {
           "recipient_email": "a@example.com",
           "subject": "Your order has shipped",
           "body": "Tracking XY123456789EE."
         }
       ]
     }'

curl -X POST https://api.beaconbox.eu/api/v1/messages/batch \
  -H "Authorization: Bearer $BEACONBOX_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 8f2b1c04-3d6a-4e55-9a12-77c0b4e9d100" \
  -d '{
       "items": [
         {
           "recipient_email": "a@example.com",
           "subject": "Your order has shipped",
           "body": "Tracking XY123456789EE."
         }
       ]
     }'

client.messages.push_batch([MessagePush(...), ...])

client.messages.push_batch([MessagePush(...), ...])

$client->messages->pushBatch([new MessagePush(...), ...])

$client->messages->pushBatch([new MessagePush(...), ...])

Body

Field	Type	Description
`items` required	`object[]`

Response

Returns 200.

Field	Type	Description
`items`	`object[]`
`succeeded`	`integer`
`failed`	`integer`

Errors

Failures are { "error_code": "..." } with a stable dotted code. See Errors for the codes worth branching on and the three outcomes that look like failures and are not.

This is a write, so it requires an Idempotency-Key header. A request without one is refused with 422. See Idempotency.