Add members (static segments)

POST/v1/segments/{id}/members

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

Add up to 1,000 contacts by email. Only valid for static segments — dynamic membership is computed from conditions.

Path parameters

  • idstringrequired

    Segment id.

Body

Required · application/json

  • emailsemail[]required

Response

Add summary.

  • addedintegerrequired
  • missingstring[]required

    Addresses with no matching contact.

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/segments/id_123/members \
  -X POST \
  -H "Authorization: Bearer sk_..." \
  -H "Content-Type: application/json" \
  -d '{
    "emails": [
      "ada@example.com"
    ]
  }'

Response

200 · application/json

{
  "success": true,
  "data": {
    "added": 1,
    "missing": [
      "<missing>"
    ]
  }
}

92 endpoints · OpenAPI document