Bulk calls
Cancel bulk call
Cancel a scheduled bulk-call campaign. A campaign that is already running, or is still a draft, is refused.
DELETE/calls/bulk_call/
Bearersession
Path parameters
bulk_call_idrequiredQuery parameters
user_idintegerReseller keys only: act as one of your clients by its user id. Omit it to act on your own account. [How acting for a client works](/docs/reseller/your-clients/acting-as-clients).
curl -X DELETE 'https://omnidim.io/api/v1/calls/bulk_call/{bulk_call_id}' \ -H 'Authorization: Bearer YOUR_API_KEY'
Example response
{ "status": "success", "message": "Scheduled bulk call cancelled successfully", "current_status": "cancelled" }
BearerAuthheader
AuthorizationBearer <token>Bearer token authentication. Obtain your API key from the OmniDimension dashboard.
bulk_call_id*integerId of the bulk call campaign.
user_id?integerReseller keys only: act as one of your clients by its user id. Omit it to act on your own account. How acting for a client works.
Response body
application/jsonCampaign cancelled.
application/jsonstatus?stringmessage?stringcurrent_status?stringWas this page helpful?