Update a shift
xmatters_update_a_shiftModify an on-call shift's details—such as schedule, recurrence, members, or timezone—by sending the complete update payload for a group.
Instructions
Update a shift. POST /api/xm/1/groups/{groupID}/shifts. The definition uses the collection path; cURL/Python additionally show a path-addressed shift variant, separately cataloged. Examples submit body id while the table says shiftID; both are informational, not forced. See C08. Body fields: shiftID, name, description, recurrence, members, siteHolidays, timezone, start, end, rotation, repeatEscalation, notifyEndofEscalation, id, notifyEndOfEscalation. Reference: https://help.xmatters.com/xmapi/#update-a-shift Requires operator write opt-in and confirm:true; may notify recipients or change tenant data.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Complete API JSON payload (including nested fields). See https://help.xmatters.com/xmapi/#update-a-shift | |
| path | Yes | ||
| query | No | API query parameters; arrays are comma-joined. Documented names: none. Pagination is explicit using offset and limit; results are not automatically combined. | |
| confirm | Yes | Explicit approval of this exact mutation. Operator must also enable XMATTERS_ALLOW_WRITES. |