POST
/
schedules
Create Schedule
curl --request POST \
  --url http://localhost/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",
  "status": 0,
  "components": [
    {
      "id": 123,
      "status": 1
    }
  ]
}'
{
  "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>"
          }
        ]
      }
    }
  }
}

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 length: 255
message
string
required
scheduled_at
string<date-time>
required
completed_at
string<date-time>
required
status
enum<integer> | null
Available options:
0,
1,
2
components
ScheduleComponentRequestData · object[] | null

Response

Schedule

data
object
required