Endpoints
Capabilities are POSTs to /v1/<name> with a JSON body. Webhook management uses /v1/hooks.
Each capability below is called as POST /v1/<name>. Send {} when a capability takes no arguments. Successful responses wrap the payload as { ok: true, data }.
Campaigns
POST
/v1/listCampaignsList campaigns and their status.POST
/v1/launchCampaignLaunch a ready campaign across its enabled channels.POST
/v1/uploadLeadsAdd or replace a campaign roster.POST
/v1/getCampaignStatsSent / opened / replied / bounced rollups.POST
/v1/getRiskScorePre-send deliverability risk score.POST
/v1/getInboxPlacementInbox vs spam placement by provider.POST
/v1/getRecentActivityRecent engagement events.POST
/v1/generateEmailImageGenerate a hero image for an email.Domains
POST
/v1/searchDomainFind registrable sending domains and prices.POST
/v1/buyDomainBuy a domain and provision its mailboxes.POST
/v1/listDomainsList sending domains and their health.POST
/v1/getSendingPoolThe current pool of domains and mailboxes.POST
/v1/sizeSendingPoolHow much pool a target volume needs.Calls
POST
/v1/callRecipientPlace an AI voice call to a recipient.POST
/v1/getRecentCallsRecent calls with outcomes.Messaging
POST
/v1/sendSmsSend an SMS message.POST
/v1/sendWhatsappSend a WhatsApp message.Webhooks
GET
/v1/hooksList your webhook subscriptions.POST
/v1/hooksSubscribe a URL to engagement events.DELETE
/v1/hooks/{id}Remove a webhook subscription.