Campaigns

Add several people to a campaign

For a batch list or a playbook backfill (up to 500 per call). People already on the roster (same recipientId, sourceSystem+externalId, or one matching email) are skipped. An active playbook needs no expectedPolicyVersion and stays on; with auto-approve on, new people are evaluated like single adds. Any other campaign needs the current expectedPolicyVersion, returns to draft and its limits expand to fit. For one person per trigger use POST /playbooks/{id}/people.

post/campaigns/{id}/recipients

Request

  • Base URL: https://gtmswag.com/api/v1
  • URL: https://gtmswag.com/api/v1/campaigns/{id}/recipients
  • Auth: HTTP bearer

Path parameters

idstring required

Campaign or playbook ID (cmp_).

Request body

expectedPolicyVersioninteger

The campaign's current policyVersion; a stale value returns POLICY_CHANGED.

Response

Success: {"data": Campaign}.

Changes

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