PUT
/
schedules
/
{schedule}
curl --request PUT \
  --url http://localhost/api/schedules/{schedule} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "message": "<string>",
  "status": 0,
  "scheduled_at": "<string>",
  "components": [
    {
      "id": 123,
      "status": 1
    }
  ]
}'
{
  "data": {
    "id": "<string>",
    "type": "schedules",
    "attributes": {
      "id": "<string>",
      "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": [
          {
            "id": "<string>",
            "type": "components",
            "attributes": {
              "id": "<string>",
              "name": "<string>",
              "description": "<string>",
              "link": "<string>",
              "order": "<string>",
              "status": {
                "human": "<string>",
                "value": "<string>"
              },
              "enabled": "<string>",
              "meta": "<string>",
              "created": {
                "human": "<string>",
                "string": "<string>"
              },
              "updated": {
                "human": "<string>",
                "string": "<string>"
              }
            },
            "relationships": {
              "group": {
                "data": {
                  "id": "<string>",
                  "type": "componentGroups",
                  "attributes": {
                    "id": "<string>",
                    "name": "<string>",
                    "order": "<string>",
                    "visible": "<string>",
                    "created": {
                      "human": "<string>",
                      "string": "<string>"
                    },
                    "updated": {
                      "human": "<string>",
                      "string": "<string>"
                    }
                  },
                  "relationships": {
                    "components": {
                      "data": [
                        {}
                      ]
                    }
                  }
                }
              },
              "incidents": {
                "data": [
                  {
                    "id": "<string>",
                    "type": "incidents",
                    "attributes": {
                      "id": "<string>",
                      "guid": "<string>",
                      "name": "<string>",
                      "message": "<string>",
                      "component_id": "<string>",
                      "visible": "<string>",
                      "stickied": "<string>",
                      "notifications": "<string>",
                      "status": {
                        "human": "<string>",
                        "value": "<string>"
                      },
                      "occurred": {
                        "human": "<string>",
                        "string": "<string>"
                      },
                      "created": {
                        "human": "<string>",
                        "string": "<string>"
                      },
                      "updated": {
                        "human": "<string>",
                        "string": "<string>"
                      }
                    },
                    "relationships": {
                      "components": {
                        "data": [
                          {}
                        ]
                      },
                      "updates": {
                        "data": [
                          {
                            "id": "<string>",
                            "type": "updates",
                            "attributes": {
                              "id": "<string>",
                              "updateable_id": "<string>",
                              "updateable_type": "<string>",
                              "message": "<string>",
                              "status": {
                                "human": "<string>",
                                "value": "<string>"
                              },
                              "created": {
                                "human": "<string>",
                                "string": "<string>"
                              },
                              "updated": {
                                "human": "<string>",
                                "string": "<string>"
                              }
                            }
                          }
                        ]
                      },
                      "user": {
                        "data": {
                          "id": "<string>",
                          "type": "<string>",
                          "attributes": {
                            "id": "<string>"
                          }
                        }
                      }
                    }
                  }
                ]
              }
            }
          }
        ]
      },
      "updates": {
        "data": [
          {
            "id": "<string>",
            "type": "updates",
            "attributes": {
              "id": "<string>",
              "updateable_id": "<string>",
              "updateable_type": "<string>",
              "message": "<string>",
              "status": {
                "human": "<string>",
                "value": "<string>"
              },
              "created": {
                "human": "<string>",
                "string": "<string>"
              },
              "updated": {
                "human": "<string>",
                "string": "<string>"
              }
            }
          }
        ]
      }
    }
  }
}

Authorizations

Authorization
string
header
required

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

Path Parameters

schedule
integer
required

The schedule ID

Body

application/json
`UpdateScheduleRequestData`
name
string | null
Maximum length: 255
message
string | null
status
enum<integer> | null
Available options:
0,
1,
2
scheduled_at
string | null
components
object[] | null

Response

200
application/json
`Schedule`
data
object
required