Campaigns
Create a campaign
client.campaigns.create(CampaignCreateParams { assistant_id, contacts, launch, 5 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}
Update a campaign
client.campaigns.update(stringid, CampaignUpdateParams { assistant_id, call_retry_config, contacts, 4 more } body?, RequestOptionsoptions?): CampaignUpdateResponse { campaign }
PATCH/campaigns/{id}
Delete a campaign
client.campaigns.delete(stringid, RequestOptionsoptions?): CampaignDeleteResponse { success }
DELETE/campaigns/{id}
Launch a draft campaign
client.campaigns.launch(stringid, RequestOptionsoptions?): CampaignLaunchResponse { campaign }
POST/campaigns/{id}/launch
Pause a running campaign
client.campaigns.pause(stringid, RequestOptionsoptions?): CampaignPauseResponse { success }
POST/campaigns/{id}/pause
Resume a paused campaign
client.campaigns.resume(stringid, RequestOptionsoptions?): CampaignResumeResponse { success }
POST/campaigns/{id}/resume
Cancel a campaign
client.campaigns.cancel(stringid, RequestOptionsoptions?): CampaignCancelResponse { success }
POST/campaigns/{id}/cancel
Get campaign statistics
client.campaigns.statistics(stringid, RequestOptionsoptions?): CampaignStatisticsResponse { statistics }
GET/campaigns/{id}/statistics
Get campaign rows
client.campaigns.getRows(stringid, RequestOptionsoptions?): CampaignGetRowsResponse { rows }
GET/campaigns/{id}/rows
Export campaign rows
client.campaigns.exportRows(stringid, RequestOptionsoptions?): CampaignExportRowsResponse { csv, filename }
GET/campaigns/{id}/export