Create a shift
xmatters_create_a_shiftCreate a shift for an xMatters group. Use the group ID, shift name, and schedule details to set up on-call coverage, requiring explicit confirmation for the change.
Instructions
Create a shift. POST /api/xm/1/groups/{groupID}/shifts/. The definition omits its initial slash; the standard base URL and request examples establish the full root path. Its trailing slash is preserved. Name is required; start/end and recurrence fields are conditional. See C04. Body fields: name, description, recurrence, members, siteHolidays, timezone, start, end, rotation, repeatEscalation, notifyEndofEscalation, notifyEndOfEscalation. Reference: https://help.xmatters.com/xmapi/#create-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/#create-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. |