Test-send a campaign

POST/v1/campaigns/{id}/test-send

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

Sends the campaign content to one address, subject prefixed with "[Test]".

Path parameters

  • idstringrequired

    Campaign id.

Body

Required · application/json

  • toemailrequired

Errors

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

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

Request

curl https://api.volanea.com/v1/campaigns/id_123/test-send \
  -X POST \
  -H "Authorization: Bearer sk_..." \
  -H "Content-Type: application/json" \
  -d '{
    "to": "ada@example.com"
  }'

Response

200 · application/json

{
  "success": true,
  "data": {
    "id": "<id>",
    "to": "ada@example.com",
    "status": "sent"
  }
}

92 endpoints · OpenAPI document