Scheduled Mutes API

Contents

• Scheduled Mutes API

  • Creating scheduled mutes

  • Searching scheduled mutes

  • Obtain information on a single scheduled mute

  • Updating scheduled mutes

  • Deleting scheduled mutes

Creating scheduled mutes

Create a scheduled mute

POST /v2/schedules/

Path Parameters

Name	Type	Description
name*	String	A name that uniquely identifies this scheduled mute.
start_time*	String	A 24-hour time string at which the scheduled mute will begin.
duration*	String	Mute time in minutes.
timezone	String	The timezone string for this scheduled mute’s start time. Valid values are “UTC-12”...”UTC-1”, “UTC”, “UTC+1”...”UTC+14”. Defaults to “UTC” if not specified.
repeat	String	The list of days at which the scheduled mute will repeat on. Becomes a one-time scheduled mute if not specified. Valid values are “mon”, “tue”, “wed”, “thu”, “fri”, “sat” and “sun”.

201: Created HTTP/1.1 201 Content-Type: application/json { "id": "<scheduled_mute_id>", "url": "/v2/schedules/<scheduled_mute_id>" }

400: Bad Request Invalid

409: Conflict Already exists

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://[e-mail]/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.

---

Searching scheduled mutes

Search scheduled mutes

GET /v2/schedules/?

Returns a JSON object containing information on scheduled mutes matching the search query. Returns all scheduled mutes if the parameter is left empty.

Path Parameters

Name	Type	Description
name	String	Format: &name=<scheduled_mute_name1>&name=<scheduled_mute_name2> The scheduled mute name to search for. Can specify multiple scheduled mute names to search for more than 1. Performs an OR operation so a query such as &name=<scheduled_mute_name1>&name=<scheduled_mute_name2> will return info on both scheduled_mute_name1 and scheduled_mute_name2.
id	String	Format: &id=<scheduled_mute_id1>&id=<scheduled_mute_id2> The scheduled mute ID to search for. Can specify multiple scheduled mute IDs to search for more than 1. Performs an OR operation so a query such as &name=<scheduled_mute_id1>&name=<scheduled_mute_id2> will return info on both scheduled_mute_id1 and scheduled_mute_id2.
duration	String	Format: &duration=<duration1>&id=<duration2> Searches for scheduled mutes by their duration. Can specify multiple durations to search for. Performs an OR operation so a query such as &duration=30&duration=10 will return scheduled mutes with a 10-minute duration or a 30-minute duration.
start_time	String	Format: &start_time=<start_time1>&start_time=<start_time2> Searches for scheduled mutes by their start time. Can specify multiple start times to search for. Performs an OR operation so a query such as &start_time=12:00&start_time=20:00 will return scheduled mutes that start at either 12 PM or 8 PM.
timezone	String	Format: &timezone=<timezone1>&timezone=<timezone2> Searches for scheduled mutes by their timezone. Can specify multiple time zones to search for. Performs an OR operation so a query such as &timezone=UTC+2&timezone=UTC-14 will return scheduled mutes that have either UTC+2 or UTC-14 time zones.
repeat	String	Format: &repeat=<day1>&repeat=<day2> Searches for scheduled mutes by their repeat days. Can specify multiple repeat days to search for. Performs an OR operation so a query such as &repeat=sun&repeat=thu will return scheduled mutes that repeat on either Sunday or Thursday.
page	String	Format: &page=1 The page number to query. Used if there are more items that can be displayed in a single request (default: 1).
max	String	Format: &max=50 The maximum number of items to display. Limit of 100 (default: 100).

200: OK HTTP/1.1 200 Content-Type: application/json { "scheduled_mutes": [ { "name": "name of scheduled mute", "id": "scheduled mute ID", "duration": 123, "alerts" : ["alert_id1", "alert_id2", "alert_id3"], "start_time": "20:20", "timezone": "UTC+4", "repeat": ["mon", "wed", "fri"] }, ... ], "next_page": False | <page_number> }

400: Bad Request Invalid

Curl example:

curl -X GET "https://[e-mail]/v2/schedules/?"

Specifying multiple fields performs an OR operation and returns scheduled mutes that match either criterion.

---

Obtain information on a single scheduled mute

Search information on a single scheduled mute

GET /v2/schedules/<scheduled_mute_id>/

Returns information on a single scheduled mute identified by <scheduled_mute_id>.

200: OK HTTP/1.1 200 Content-Type: application/json { "name": "name of scheduled mute", "id": "scheduled mute ID", "duration": 123, "alerts" : ["alert_id1", "alert_id2", "alert_id3"], "start_time": "20:20", "timezone": "UTC+4", "repeat": ["mon", "wed", "fri"] }

404: Not Found Scheduled mute doesn’t exist.

Curl example:

curl -X GET "https://[e-mail]/v2/schedules/123-456-789/"

Obtain information on the scheduled mute identified by the ID 123-456-789.

---

Updating scheduled mutes

Update a scheduled mute

PUT /v2/schedules/<scheduled_mute_id>/

Updates the attributes of a scheduled mute identified by <scheduled_mute_id>.

Path Parameters

Name	Type	Description
name	String	A name that uniquely identifies this scheduled mute.
start_time	String	A 24-hour time string at which the scheduled mute will begin
dduration	String	Mute time in minutes.
timezone	String	The timezone string for this scheduled mute’s start time. Valid values are “UTC-12”...”UTC-1”, “UTC”, “UTC+1”...”UTC+14”. Defaults to “UTC” if not specified.
repeat	String	The list of days at which the scheduled mute will repeat on. Becomes a one-time scheduled mute if not specified. Valid values are “mon”, “tue”, “wed”, “thu”, “fri”, “sat” and “sun”.

200: OK { "name": "string", "start_time": "14:20", "duration": 123, "timezone": "UTC-2", "repeat": ["mon", "tue", "wed", "thu", "fri", "sat", "sun"] }

400: Bad Request Invalid

404: Not Found Scheduled mute doesn’t exist.

409: Conflict Scheduled mute with the updated name already exists.

Curl example:

curl -H "Content-Type: application/json" -X PUT \
-d '{"start_time": "14:50", "timezone": "UTC+12"}' \
"https://[e-mail]/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.

---

Deleting scheduled mutes

Delete a scheduled mute

DELETE /v2/schedules/<scheduled_mute_id>/

Deletes a scheduled mute identified by <scheduled_mute_id>.

200: OK

404: Not Found Scheduled mute doesn’t exist.

Curl example:

curl -X DELETE "https://[e-mail]/v2/schedules/123-456-789/"

Delete the scheduled mute identified by the ID 123-456-789.