Enroll Contacts in a Campaign

POST /v1/campaigns/{campaign_id}/contacts

Enrolls up to 100 Contacts by id or by inline identities, upserted as Contacts, or a completed Contact import as a campaign.enrollment_import job, from draft until enrollment_closes_at (1.65.0; section 3.1). Each enrollment is unique per Campaign and Contact, so a Contact already enrolled answers its enrollment with created false; one that fails a check is recorded ineligible with its code. A Campaign whose enrollment closed or that ended is campaign_conflict; variables in an Organization that keeps no content are zero_retention_variables_not_allowed. The Idempotency-Key makes a repeated request answer the same batch.

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the campaigns:write scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl -X POST "$VOCAL_API/v1/campaigns/cmp_.../contacts" \
  -H "Authorization: Bearer $VOCAL_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'

const response = await fetch(`${process.env.VOCAL_API}/v1/campaigns/cmp_.../contacts`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
    'Idempotency-Key': crypto.randomUUID(),
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
});
console.log(response.status, await response.text());

import os
import uuid

import requests

response = requests.post(
    f"{os.environ['VOCAL_API']}/v1/campaigns/cmp_.../contacts",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={},
)
print(response.status_code, response.text)

Parameters

Request body

Content type application/json, required: CampaignEnrollRequest.

Responses

Fields of the 200 answer

The shape is CampaignEnrollmentBatch.