Skip to main content
The lettr.campaigns() service gives you read access to campaigns plus lifecycle actions — send now, schedule, and unschedule. The SDK doesn’t create campaigns yet. To create a draft from code, call the create a campaign endpoint directly, then send or schedule it with the SDK. Editing and deleting campaigns happen in the dashboard. Reads require an API key with the campaigns:read scope; actions require campaigns:write.

List Campaigns

API Reference

GET /campaigns

Get a Campaign

get() returns CampaignDetail, which extends CampaignView and adds htmlContent. The action endpoints (send, schedule, unschedule) and list() return the base CampaignView, so they cannot accidentally expose HTML content.

API Reference

GET /campaigns/

List Campaign Events

Events use cursor-based pagination. Keep requesting with the returned cursor until it is null. A filtered page may come back with no events but a non-null cursor — that means more pages remain, so keep going.

API Reference

GET /campaigns//events

Send / Schedule / Unschedule

Send

POST /campaigns//send

Schedule

POST /campaigns//schedule

Unschedule

POST /campaigns//unschedule

What’s Next

Audience

Manage the contacts campaigns send to

API Reference

Full campaigns API reference