Skip to Content
API access is available to organizations with a signed BAA. Request API access →
API referenceThe Campaign object

The Campaign object

One message sent to many patients from a clinic phone number, with per-patient delivery.

Attributes

idUUIDRequired

Unique ID of the campaign.

namestringRequired

A name for staff, like “Flu shot reminders, October”. Patients never see it.

statusdraft, running, paused, completed, stoppedRequired

draft until started; completed once every recipient is sent; stopped if someone stopped it early.

channelsecure, smsRequired

How recipients receive the message. Secure unless the campaign asks for SMS.

bodystringRequired

The message every recipient gets.

phone_numberPhoneNumberRefRequired

The clinic phone number a patient conversation is on.

Show child attributes
numberstringRequired

The phone number.

teamstringRequired

The team it belongs to.

senderCampaignSenderRequired

Who the campaign’s messages come from.

Show child attributes
idUUIDRequired

ID of the admin or API key.

namestringRequired

The admin’s name, or the API key’s name, like “Reminder service”.

kindstaff, api_keyRequired

Whether an org admin (through OAuth) or an API key created the campaign.

send_interval_secondsnumberRequired

Seconds between messages.

countsCampaignCountsRequired

Progress across the campaign’s recipients.

Show child attributes
recipientsintegerRequired

Patients on the campaign.

pendingintegerRequired

Waiting to be sent.

sentintegerRequired

Sent, including delivered.

deliveredintegerRequired

Confirmed delivered or opened.

failedintegerRequired

Failed or undelivered.

skippedintegerRequired

Not sent: opted out, no contact method, or cancelled.

archivedbooleanRequired

Whether the campaign is archived.

created_attimestampRequired

When the campaign was created.

started_attimestamp or nullRequired

When it first started. Null for a draft.

finished_attimestamp or nullRequired

When it completed or was stopped. Null otherwise.

Endpoints

MethodPathEndpoint
GET/campaignsList campaigns
POST/campaignsCreate a campaign
GET/campaigns/{campaignId}Retrieve a campaign
PATCH/campaigns/{campaignId}Update a campaign
DELETE/campaigns/{campaignId}Delete a campaign
GET/campaigns/{campaignId}/recipientsList campaign recipients
POST/campaigns/{campaignId}/recipientsAdd campaign recipients
POST/campaigns/{campaignId}/recipients/removeRemove campaign recipients
POST/campaigns/{campaignId}/startStart a campaign
POST/campaigns/{campaignId}/pausePause a campaign
POST/campaigns/{campaignId}/stopStop a campaign
Last updated on
List phone numbersList campaigns