Set calling hours
Restrict a campaign to a daily calling window, in the campaign's timezone. Outside the window the campaign holds rather than finishing, and resumes the next day.
bulk_call_idrequiredReseller 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).
Stop dialing at daily_stop_time each day.
Hour of day to stop, 0 to 23. Fractions are allowed, so 17.5 is 17:30. Required when the hard stop is on.
Resume dialing at daily_start_time each day.
curl -X PUT 'https://omnidim.io/api/v1/calls/bulk_call/{bulk_call_id}/daily-time-control' \ -H 'Authorization: Bearer YOUR_API_KEY' \ -H 'Content-Type: application/json' \ -d '{ "user_id": 1234, "enable_daily_hard_stop": true, "daily_stop_time": 18, "daily_stop_timezone": "Asia/Kolkata", "enable_daily_auto_start": true, "daily_start_time": 9, "daily_start_timezone": "Asia/Kolkata" }'
{ "status": "success", "message": "Daily time control updated" }
BearerAuthAuthorizationBearer <token>Bearer token authentication. Obtain your API key from the OmniDimension dashboard.
bulk_call_id*integerId of the bulk call campaign.
application/jsonuser_id?ClientUserIdReseller 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.
enable_daily_hard_stop*booleanStop dialing at daily_stop_time each day.
daily_stop_time?numberHour of day to stop, 0 to 23. Fractions are allowed, so
17.5 is 17:30. Required when the hard stop is on.
daily_stop_timezone?stringTimezone for the stop time.
enable_daily_auto_start*booleanResume dialing at daily_start_time each day.
daily_start_time?numberHour of day to resume, 0 to 23. Required when auto start is on.
daily_start_timezone?stringTimezone for the start time.
Response body
application/jsonUpdated calling window.
application/jsonstatus?stringmessage?stringWas this page helpful?