API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Campaigns

Create a campaign

campaigns.create(**kwargs) -> CampaignCreateResponse { campaign }

POST/campaigns

List campaigns

campaigns.list() -> CampaignListResponse { campaigns }

GET/campaigns

Get campaign by ID

campaigns.retrieve(id) -> CampaignRetrieveResponse { campaign }

GET/campaigns/{id}

Delete a campaign

campaigns.delete(id) -> CampaignDeleteResponse { success }

DELETE/campaigns/{id}

Cancel a campaign

campaigns.cancel(id) -> CampaignCancelResponse { success }

POST/campaigns/{id}/cancel

Get campaign rows

campaigns.get_rows(id, **kwargs) -> CampaignGetRowsResponse { page, page_size, rows, total }

GET/campaigns/{id}/rows

Export campaign rows

campaigns.export_rows(id) -> CampaignExportRowsResponse { csv, filename }

GET/campaigns/{id}/export