Add Campaign Member

Add one member to a custom campaign by email. Same rules as POST /v2/campaigns/{campaignId}/members/batch: the contact is created if it does not exist, adding is an idempotent upsert, and status progression is forward-only for existing members.

post/v2/campaigns/{campaignId}/members

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

emailstring email required

The member's email address, normalized (trimmed and lowercased) before matching. An invalid email returns 400 invalid_email and creates no contact.

statusIdstring uuid

The campaign status id to place the member in, as returned by GET /v2/campaigns/{campaignId}. Takes precedence over status. An id that is not a status of the campaign's type returns 400 invalid_campaign_status.

statusstring

The campaign status name, case-insensitive. Used only when statusId is not set. Omit both to use the campaign type's first status.

Example request

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

Response

Member added or updated.

Changes

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