API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Campaigns

Create a campaign

campaigns.create(CampaignCreateParams**kwargs) -> CampaignCreateResponse

POST/campaigns

List campaigns

campaigns.list() -> CampaignListResponse

GET/campaigns

Get campaign by ID

campaigns.retrieve(strid) -> CampaignRetrieveResponse

GET/campaigns/{id}

Delete a campaign

campaigns.delete(strid) -> CampaignDeleteResponse

DELETE/campaigns/{id}

Cancel a campaign

campaigns.cancel(strid) -> CampaignCancelResponse

POST/campaigns/{id}/cancel

Get campaign rows

campaigns.get_rows(strid, CampaignGetRowsParams**kwargs) -> CampaignGetRowsResponse

GET/campaigns/{id}/rows

Export campaign rows

campaigns.export_rows(strid) -> CampaignExportRowsResponse

GET/campaigns/{id}/export