Skip to main content
POST
/
schedules
Create Schedule
curl --request POST \
  --url http://localhost:8001/api/schedules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "message": "<string>",
  "scheduled_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "notifications": false,
  "components": [
    {
      "id": 123
    }
  ]
}
'
import requests

url = "http://localhost:8001/api/schedules"

payload = {
"name": "<string>",
"message": "<string>",
"scheduled_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"notifications": False,
"components": [{ "id": 123 }]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
message: '<string>',
scheduled_at: '2023-11-07T05:31:56Z',
completed_at: '2023-11-07T05:31:56Z',
notifications: false,
components: [{id: 123}]
})
};

fetch('http://localhost:8001/api/schedules', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_PORT => "8001",
CURLOPT_URL => "http://localhost:8001/api/schedules",
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([
'name' => '<string>',
'message' => '<string>',
'scheduled_at' => '2023-11-07T05:31:56Z',
'completed_at' => '2023-11-07T05:31:56Z',
'notifications' => false,
'components' => [
[
'id' => 123
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/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 := "http://localhost:8001/api/schedules"

payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"message\": \"<string>\",\n \"scheduled_at\": \"2023-11-07T05:31:56Z\",\n \"completed_at\": \"2023-11-07T05:31:56Z\",\n \"notifications\": false,\n \"components\": [\n {\n \"id\": 123\n }\n ]\n}")

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

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

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("http://localhost:8001/api/schedules")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"message\": \"<string>\",\n \"scheduled_at\": \"2023-11-07T05:31:56Z\",\n \"completed_at\": \"2023-11-07T05:31:56Z\",\n \"notifications\": false,\n \"components\": [\n {\n \"id\": 123\n }\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("http://localhost:8001/api/schedules")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"message\": \"<string>\",\n \"scheduled_at\": \"2023-11-07T05:31:56Z\",\n \"completed_at\": \"2023-11-07T05:31:56Z\",\n \"notifications\": false,\n \"components\": [\n {\n \"id\": 123\n }\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "id": "<string>",
    "type": "schedules",
    "attributes": {
      "id": 123,
      "name": "<string>",
      "message": "<string>",
      "status": {
        "human": "<string>",
        "value": "<string>"
      },
      "scheduled": {
        "human": "<string>",
        "string": "<string>"
      },
      "completed": {
        "human": "<string>",
        "string": "<string>"
      },
      "created": {
        "human": "<string>",
        "string": "<string>"
      },
      "updated": {
        "human": "<string>",
        "string": "<string>"
      }
    },
    "relationships": {
      "components": {
        "data": [
          {
            "type": "components",
            "id": "<string>"
          }
        ]
      },
      "updates": {
        "data": [
          {
            "type": "updates",
            "id": "<string>"
          }
        ]
      }
    }
  },
  "included": [
    {
      "id": "<string>",
      "type": "components",
      "attributes": {
        "id": 123,
        "name": "<string>",
        "description": "<string>",
        "link": "<string>",
        "order": 123,
        "status": {
          "value": 123
        },
        "enabled": true,
        "meta": [
          "<unknown>"
        ],
        "created": {
          "human": "<string>",
          "string": "<string>"
        },
        "updated": {
          "human": "<string>",
          "string": "<string>"
        },
        "pivot": {
          "component_status": {
            "human": "<string>",
            "value": "<string>"
          }
        }
      },
      "relationships": {
        "group": {
          "data": {
            "type": "componentGroups",
            "id": "<string>"
          }
        },
        "incidents": {
          "data": [
            {
              "type": "incidents",
              "id": "<string>"
            }
          ]
        }
      }
    }
  ]
}
{
"message": "<string>"
}
{
"message": "<string>"
}
{
"message": "<string>",
"errors": {}
}

Authorizations

Authorization
string
header
required

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

Body

application/json

CreateScheduleRequestData

name
string
required
Maximum string length: 255
message
string
required
scheduled_at
string<date-time>
required
completed_at
string<date-time> | null
status
enum<integer> | null
Available options:
0,
1,
2
notifications
boolean
default:false
components
ScheduleComponentRequestData · object[] | null

Response

Schedule

data
Schedule · object
required
included
(Component · object | Update · object)[]