Batch Add Campaign Members

Add up to 200 members to a custom campaign by email, creating contacts that do not exist yet. Adding is an idempotent upsert: a contact already in the campaign has its status updated instead of being added twice.

Status progression is forward-only for existing members; requesting their current or an earlier status leaves it unchanged. Set a status by statusId or status from GET /v2/campaigns/{campaignId}, or omit both to use the campaign type's first status. Members are processed independently, so one can fail while the rest of the batch succeeds.

post/v2/campaigns/{campaignId}/members/batch

Request

  • Base URL
    https://pub-api.conversion.ai/api
  • Auth
    • API key in header X-API-Key
    • or API key in query parameter api_key

Path parameters

campaignIdstring uuid required

The Conversion campaign id, as returned by GET /v2/campaigns.

Request body

Example request

{
  "members": [
    {
      "email": "jane@example.com",
      "statusId": "8f9a0b1c-2d3e-4f4a-9b5c-6d7e8f9a0b1c",
      "status": "Attended"
    }
  ]
}

Response

Batch processed. Check the counts and each result for per-member success or failure.

Changes

No recorded changes to this operation across all 1 revision of this API.