Links

Scheduled Mutes API

Contents
post
/v2/schedules/
Create a scheduled mute
Request format:
{
"name": "string",
"start_time": "14:20",
"duration": 123,
"timezone": "UTC-2",
"repeat": ["mon", "tue", "wed", "thu", "fri", "sat", "sun"]
}
Curl example
curl -H "Content-Type: application/json" -X POST -d \
'{"name": "Mute on weekends", "start_time": "00:00", "duration": 1440, "timezone": "UTC+2", "repeat": ["sat", "sun"]}' \
"https://[email protected]/v2/schedules/"
Creates a scheduled mute named “Mute on weekends” that starts at 12 AM in timezone UTC+2, with a mute duration of 24 hours, and repeats every Saturday and Sunday.

get
/v2/schedules/?
Search scheduled mutes
Curl example:
curl -X GET "https://[email protected]/v2/schedules/?"
Specifying multiple fields performs an OR operation and returns scheduled mutes that match either criterion.

get
/v2/schedules/<scheduled_mute_id>/
Search information on a single scheduled mute
Curl example:
curl -X GET "https://[email protected]/v2/schedules/123-456-789/"
Obtain information on the scheduled mute identified by the ID 123-456-789.

put
/v2/schedules/<scheduled_mute_id>/
Update a scheduled mute
Curl example:
curl -H "Content-Type: application/json" -X PUT \
-d '{"start_time": "14:50", "timezone": "UTC+12"}' \
"https://[email protected]/v2/schedules/123-456-789/"
Updates the start time and timezone of the scheduled mute with the id 123-456-789.
Each field is optional and only the specified fields are updated.

delete
/v2/schedules/<scheduled_mute_id>/
Delete a scheduled mute
Curl example:
curl -X DELETE "https://[email protected]/v2/schedules/123-456-789/"
Delete the scheduled mute identified by the ID 123-456-789.