Enrollments

Enroll prospects

Adds prospects to a campaign by prospect id, audience list id, email, and/or WhatsApp number. Suppressed prospects are skipped and counted separately. Provide at least one of prospectIds, listIds, emails, whatsappPhones. Emails and numbers that match no existing lead are reported back rather than silently dropped. Enrolling new prospects into a completed campaign reopens it for them (campaignReopened: true) — prospects already in it, including those who finished, are skipped and never emailed again, and sending is paced by the scheduler as usual.

Required scope: enrollments:write.

Requires a unique Idempotency-Key request header so retries never duplicate.

post/campaigns/{id}/enrollments

Request

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

Path parameters

idstring required

Campaign id (UUID).

Headers

Idempotency-Keystring required

A unique key (e.g. a UUID) that makes this write safe to retry. Reusing a key returns the original result; reusing it with a different body returns 409.

Request body

prospectIdsstring[]

Prospect ids to enroll.

listIdsstring[]

Audience list ids — every prospect on each list is enrolled.

emailsstring[]

Prospect emails to enroll.

whatsappPhonesstring[]

WhatsApp numbers of existing leads to enroll. Any human format is accepted (+49 171 234 5678, 0049…, bare digits, a wa.me link) and normalized before matching.

Response

Success

Changes

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