Outreach API

Email and SMS campaigns to a segment: write one or generate a draft, set its steps, check readiness, preview it, schedule it, and pause, resume or cancel a send in flight. Also the sending identities a campaign goes out over and the suppression list it must respect.

On this page

Endpoints
Authentication
Objects returned

Endpoints#

27 operations, each with its parameters, schemas and an example request on its own page.

getList campaigns/api/outreach/campaigns
postCreate campaign/api/outreach/campaigns
getRead campaign/api/outreach/campaigns/{campaign_id}
patchUpdate campaign/api/outreach/campaigns/{campaign_id}
deleteDelete campaign/api/outreach/campaigns/{campaign_id}
postCancel campaign/api/outreach/campaigns/{campaign_id}/cancelAlso never gated, for the same reason as pause.
postGenerate campaign/api/outreach/campaigns/{campaign_id}/generateWrites a sequence with a model and saves it as a draft.
getCampaign messages/api/outreach/campaigns/{campaign_id}/messagesThe send log. Masked addresses only - see the migration docstring.
postPause campaign/api/outreach/campaigns/{campaign_id}/pauseNever gated. A stop button behind a plan check is an incident.
getPreview campaign/api/outreach/campaigns/{campaign_id}/previewThe sequence rendered against real leads from its segment.
getCampaign readiness/api/outreach/campaigns/{campaign_id}/readinessEvery reason this campaign cannot send yet, at once.
postResume campaign/api/outreach/campaigns/{campaign_id}/resume
postSchedule campaign/api/outreach/campaigns/{campaign_id}/scheduleThe one-way door: enrols the audience and starts sending.
putSet steps/api/outreach/campaigns/{campaign_id}/steps
getDns records/api/outreach/dns-recordsThe records to publish, before anything is saved.
getList identities/api/outreach/identities
postCreate identity/api/outreach/identitiesStores a tenant's own sending credential.
getRead identity/api/outreach/identities/{identity_id}
patchUpdate identity/api/outreach/identities/{identity_id}
deleteDelete identity/api/outreach/identities/{identity_id}
postCheck identity/api/outreach/identities/{identity_id}/checkConnects and authenticates, and looks up SPF, DKIM and DMARC. Sends nothing.
postTest identity/api/outreach/identities/{identity_id}/testSends one real message. This is what sets verified_at.
getOptions/api/outreach/optionsEverything a setup screen needs, so nothing is hard-coded in the client.
postRun now/api/outreach/runRuns one sending tick for this workspace's due enrollments.
getList suppressions/api/outreach/suppressions
postAdd suppression/api/outreach/suppressions
deleteRemove suppression/api/outreach/suppressions/{email_bidx}Only lifts a manual entry. A bounce stays, permanently.

Authentication#

Every call here needs Authorization: Bearer with a key from the dashboard — Authentication covers keys and scopes.

Objects returned#

The models these endpoints send back, with every field. Open one to read it.

Message2 fields

messagestringrequired
okboolean
Default: true

Something unclear or missing? Tell us and we’ll fix it.