Create a scenario
xmatters_create_a_scenarioCreate a new xMatters scenario from a form, specifying recipients, priority, and escalation options to trigger targeted notifications.
Instructions
Create a scenario. POST /api/xm/1/forms/{formId}/scenarios. Body fields: attachments, bypassPhoneIntro, description, escalationOverride, expirationInMinutes, name, overrideDeviceRestrictions, permitted, priority, properties, recipients, requirePhonePassword, senderOverrides, targetDeviceNames, voicemailOptions. Reference: https://help.xmatters.com/xmapi/#create-a-scenario 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-scenario | |
| 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. |