Create a scheduled message
xmatters_create_a_scheduled_messageCreate a scheduled message with event and recurrence details for future delivery. Confirm the action to execute the mutation.
Instructions
Create a scheduled message. POST /api/xm/1/scheduled-messages. Nested event and recurrence objects remain open; consult the Scheduled Message and MessageRecurrence objects. Body fields: name, event, attachments, recurrence. Reference: https://help.xmatters.com/xmapi/#create-a-scheduled-message 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-scheduled-message | |
| 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. |