Campaigns
Create a campaign
client.campaigns.create(CampaignCreateParams { assistant_id, contacts, name, 4 more } body, RequestOptionsoptions?): CampaignCreateResponse { campaign }
POST/campaigns
List campaigns
client.campaigns.list(RequestOptionsoptions?): CampaignListResponse { campaigns }
GET/campaigns
Get campaign by ID
client.campaigns.retrieve(stringid, RequestOptionsoptions?): CampaignRetrieveResponse { campaign }
GET/campaigns/{id}
Delete a campaign
client.campaigns.delete(stringid, RequestOptionsoptions?): CampaignDeleteResponse { success }
DELETE/campaigns/{id}
Cancel a campaign
client.campaigns.cancel(stringid, RequestOptionsoptions?): CampaignCancelResponse { success }
POST/campaigns/{id}/cancel
Get campaign rows
client.campaigns.getRows(stringid, CampaignGetRowsParams { page, page_size, query, 2 more } query, RequestOptionsoptions?): CampaignGetRowsResponse { page, page_size, rows, total }
GET/campaigns/{id}/rows
Export campaign rows
client.campaigns.exportRows(stringid, RequestOptionsoptions?): CampaignExportRowsResponse { csv, filename }
GET/campaigns/{id}/export