Bulk subscribe / unsubscribe / delete / suppress

POST/v1/contacts/bulk

Secret key — sk_… or sk_test_… · Base URL https://api.volanea.com

Apply one action to up to 10,000 addresses. suppress adds addresses to the do-not-send list even if no contact exists.

Body

Required · application/json

actionenumrequired
subscribeunsubscribedeletesuppress
emailsemail[]required

Response

How many contacts were affected.

actionstringrequired
affectedintegerrequired

Errors

Every failure returns the standard envelope — branch on `code`, never on the wording of `error`.

401Missing or invalid API key.
422Request validation failed (code `validation_error`, 422).

Request

curl https://api.volanea.com/v1/contacts/bulk \
  -X POST \
  -H "Authorization: Bearer sk_..." \
  -H "Content-Type: application/json" \
  -d '{
    "action": "subscribe",
    "emails": [
      "ada@example.com"
    ]
  }'

Response

200 · application/json

{
  "success": true,
  "data": {
    "action": "<action>",
    "affected": 1
  }
}

92 endpoints · OpenAPI document