Create a plan form
xmatters_create_a_plan_formCreate a form for an existing xMatters plan, configuring its name, trigger type, and API/mobile/UI enablement. Mutation requires operator write opt-in and confirmation.
Instructions
Create a plan form. POST /api/xm/1/plans/{planId}/forms. Body fields: name, description, triggerType, mobileEnabled, uiEnabled, apiEnabled. Reference: https://help.xmatters.com/xmapi/#create-a-plan-form 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-plan-form | |
| 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. |