Campaign contacts
Add people to a campaign, see where each one is, and stop it for anyone who replied elsewhere.
Add people to a campaign from your own app or CRM, stop them, and read a campaign's results.
Authenticated with ?privateKey=YOUR_KEY (see Authentication).
| POST | /admin/email-campaign/schedule-contact | Schedule contact in email campaign |
| POST | /admin/email-campaigns/stop | Stop email campaign for specific lead |
| GET | /admin/email-campaigns-stats/{id} | Get email campaign statistics |
| POST | /v3/prospects/resume | Resume prospects |
| POST | /v3/prospects/send-now | Send to prospects now |
| POST | /v3/prospects/change-mailbox | Move prospects to another mailbox |
| POST | /v3/prospects/reschedule | Reschedule prospects |
Campaign Id is required
curl -X GET "https://rest-dash.revealid.xyz/admin/email-campaigns-stats/?privateKey=YOUR_KEY&websiteId=64b7f0a1c2d3e4f5a6b7c8d9"What each field accepts
| Field | Type | Limits and format | Accepted values |
|---|---|---|---|
| websiteId* | string | — | any |
| campaignId* | string | — | any |
Use case: Add someone from your app
POST /admin/email-campaign/schedule-contact with { "email": …, "emailCampaignId": … } and any merge fields (firstName, lastName, position, domain for the company, custom for your own fields). The campaign must be active and have at least one email; each contact uses one from your prospecting allowance.
Use case: Someone asked you to stop
POST /admin/email-campaigns/stop?leadId=…&email=… stops every campaign for that address and adds it to your unsubscribe list, so no campaign emails them again.