creates shift coverage requests

Creates coverage requests for the shifts overlapping the requested time range. A range can span multiple consecutive shifts (e.g. across a handoff), so one or more coverage requests may be created; the response is always a list. A coverage request broadcasts to schedule members so someone can volunteer to cover the shift.

POST /v1/schedules/{schedule_id}/shift_coverage_requests

creates shift coverage requests

cURL

curl --request POST \
  --url https://api.rootly.com/v1/schedules/{schedule_id}/shift_coverage_requests \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "shift_coverage_requests",
    "attributes": {
      "starts_at": "2023-11-07T05:31:56Z",
      "ends_at": "2023-11-07T05:31:56Z",
      "user_id": 123
    }
  }
}
'

import requests

url = "https://api.rootly.com/v1/schedules/{schedule_id}/shift_coverage_requests"

payload = { "data": {
        "type": "shift_coverage_requests",
        "attributes": {
            "starts_at": "2023-11-07T05:31:56Z",
            "ends_at": "2023-11-07T05:31:56Z",
            "user_id": 123
        }
    } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/vnd.api+json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/vnd.api+json'},
  body: JSON.stringify({
    data: {
      type: 'shift_coverage_requests',
      attributes: {
        starts_at: '2023-11-07T05:31:56Z',
        ends_at: '2023-11-07T05:31:56Z',
        user_id: 123
      }
    }
  })
};

fetch('https://api.rootly.com/v1/schedules/{schedule_id}/shift_coverage_requests', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.rootly.com/v1/schedules/{schedule_id}/shift_coverage_requests",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'data' => [
        'type' => 'shift_coverage_requests',
        'attributes' => [
                'starts_at' => '2023-11-07T05:31:56Z',
                'ends_at' => '2023-11-07T05:31:56Z',
                'user_id' => 123
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/vnd.api+json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.rootly.com/v1/schedules/{schedule_id}/shift_coverage_requests"

	payload := strings.NewReader("{\n  \"data\": {\n    \"type\": \"shift_coverage_requests\",\n    \"attributes\": {\n      \"starts_at\": \"2023-11-07T05:31:56Z\",\n      \"ends_at\": \"2023-11-07T05:31:56Z\",\n      \"user_id\": 123\n    }\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/vnd.api+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.rootly.com/v1/schedules/{schedule_id}/shift_coverage_requests")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/vnd.api+json")
  .body("{\n  \"data\": {\n    \"type\": \"shift_coverage_requests\",\n    \"attributes\": {\n      \"starts_at\": \"2023-11-07T05:31:56Z\",\n      \"ends_at\": \"2023-11-07T05:31:56Z\",\n      \"user_id\": 123\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.rootly.com/v1/schedules/{schedule_id}/shift_coverage_requests")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/vnd.api+json'
request.body = "{\n  \"data\": {\n    \"type\": \"shift_coverage_requests\",\n    \"attributes\": {\n      \"starts_at\": \"2023-11-07T05:31:56Z\",\n      \"ends_at\": \"2023-11-07T05:31:56Z\",\n      \"user_id\": 123\n    }\n  }\n}"

response = http.request(request)
puts response.read_body

201

{
  "data": [
    {
      "id": "<string>",
      "type": "shift_coverage_requests",
      "attributes": {
        "schedule_id": "<string>",
        "shift_id": "<string>",
        "original_shift_user_id": 123,
        "created_by_user_id": 123,
        "starts_at": "<string>",
        "ends_at": "<string>",
        "created_at": "<string>",
        "updated_at": "<string>",
        "schedule": {
          "data": {
            "id": "<string>",
            "type": "schedules",
            "attributes": {
              "name": "<string>",
              "owner_user_id": 123,
              "created_at": "<string>",
              "updated_at": "<string>",
              "description": "<string>",
              "all_time_coverage": true,
              "slack_user_group": {
                "id": "<string>",
                "name": "<string>"
              },
              "slack_channel": {
                "id": "<string>",
                "name": "<string>"
              },
              "owner_group_ids": [
                "<string>"
              ],
              "sync_linear_enabled": true,
              "include_shadows_in_slack_notifications": true,
              "shift_start_notifications_enabled": true,
              "shift_update_notifications_enabled": true,
              "shift_report_enabled": true,
              "shift_report_time_of_day": "<string>",
              "shift_report_time_zone": "<string>"
            }
          },
          "included": [
            {
              "id": "<string>",
              "type": "<string>",
              "attributes": {},
              "relationships": {}
            }
          ]
        },
        "shift": {
          "schedule_id": "<string>",
          "rotation_id": "<string>",
          "starts_at": "<string>",
          "ends_at": "<string>",
          "is_override": true,
          "is_shadow": true,
          "user_id": 123
        },
        "original_shift_user": {
          "data": {
            "id": "<string>",
            "type": "users",
            "attributes": {
              "email": "<string>",
              "created_at": "<string>",
              "updated_at": "<string>",
              "first_name": "<string>",
              "last_name": "<string>",
              "full_name": "<string>",
              "full_name_with_team": "<string>",
              "time_zone": "<string>"
            },
            "relationships": {
              "role": {
                "data": {
                  "id": "<string>",
                  "type": "roles"
                }
              },
              "on_call_role": {
                "data": {
                  "id": "<string>",
                  "type": "on_call_roles"
                }
              }
            }
          },
          "included": [
            {
              "id": "<string>",
              "type": "<string>",
              "attributes": {},
              "relationships": {}
            }
          ]
        },
        "created_by_user": {
          "data": {
            "id": "<string>",
            "type": "users",
            "attributes": {
              "email": "<string>",
              "created_at": "<string>",
              "updated_at": "<string>",
              "first_name": "<string>",
              "last_name": "<string>",
              "full_name": "<string>",
              "full_name_with_team": "<string>",
              "time_zone": "<string>"
            },
            "relationships": {
              "role": {
                "data": {
                  "id": "<string>",
                  "type": "roles"
                }
              },
              "on_call_role": {
                "data": {
                  "id": "<string>",
                  "type": "on_call_roles"
                }
              }
            }
          },
          "included": [
            {
              "id": "<string>",
              "type": "<string>",
              "attributes": {},
              "relationships": {}
            }
          ]
        }
      }
    }
  ],
  "links": {
    "self": "<string>",
    "first": "<string>",
    "prev": "<string>",
    "next": "<string>",
    "last": "<string>"
  },
  "meta": {
    "current_page": 123,
    "next_page": 123,
    "prev_page": 123,
    "total_count": 123,
    "total_pages": 123,
    "next_cursor": "<string>"
  },
  "included": [
    {
      "id": "<string>",
      "type": "<string>",
      "attributes": {},
      "relationships": {}
    }
  ]
}

{
  "errors": [
    {
      "title": "<string>",
      "status": "<string>",
      "code": "<string>",
      "detail": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

schedule_id · string · required

Body

application/vnd.api+json

data · object · required

Show child attributes

Response

201

application/vnd.api+json

without override permission, can request coverage for own shift

data · object[] · required

Show child attributes

links · object

Show child attributes

meta · object

Show child attributes

included · object[]

Show child attributes