Update schedule
PUT {{baseUrl}}/api/schedules/:id
Update all of the information for a specific schedule. You obtain the authorization token needed to execute the request using POST /auth/login. You pass the authorization token in the request header. You obtain the schedule ID using GET /schedules. You pass the schedule ID in the path of the request. You provide the information used to update the specific schedule in the body parameter of the request.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
fields | null | Comma-separated, top-level field whitelist that allows the client to selectively retrieve part of the response model. If specified, extra filtering is applied, and for top-level object (if root model is an array, each array element), only the listed fields are kept in the response. For example, "id,elements" keeps only the "id" field and whole "elements" array field, omitting all other fields in the top-level response model. |
Request Body
{"name"=>"Test schedule", "scheduleType"=>"event_based", "startDate"=>"2000-06-23T23:00:14.531Z", "event"=>{"eventId"=>"{{rd_eventId}}"}}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
X-MSTR-AuthToken | string | (Required) Authorization token | |
Content-Type | string |
RESPONSES
status: OK
{"name":"Test schedule","id":"3A015D4F0141F648DDD8F3A50328105C","description":"","scheduleType":"event_based","startDate":"2000-06-23","event":{"eventId":"46DD16B543213B52372B5FB732FB611A","name":"Books Closed"},"expired":false,"acg":255}