Skip to content
Get started

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}
Update a campaign
campaigns.update(strid, CampaignUpdateParams**kwargs) -> CampaignUpdateResponse
PATCH/campaigns/{id}
Delete a campaign
campaigns.delete(strid) -> CampaignDeleteResponse
DELETE/campaigns/{id}
Launch a draft campaign
campaigns.launch(strid) -> CampaignLaunchResponse
POST/campaigns/{id}/launch
Pause a running campaign
campaigns.pause(strid) -> CampaignPauseResponse
POST/campaigns/{id}/pause
Resume a paused campaign
campaigns.resume(strid) -> CampaignResumeResponse
POST/campaigns/{id}/resume
Cancel a campaign
campaigns.cancel(strid) -> CampaignCancelResponse
POST/campaigns/{id}/cancel
Get campaign statistics
campaigns.statistics(strid) -> CampaignStatisticsResponse
GET/campaigns/{id}/statistics
Get campaign rows
campaigns.get_rows(strid) -> CampaignGetRowsResponse
GET/campaigns/{id}/rows
Export campaign rows
campaigns.export_rows(strid) -> CampaignExportRowsResponse
GET/campaigns/{id}/export