Create plan properties
xmatters_create_plan_propertiesCreate custom properties for an xMatters plan by sending a JSON payload to a specified plan ID. Define fields like name, type, validation rules, and defaults to tailor plan data to your workflow.
Instructions
Create plan properties. POST /api/xm/1/plans/{planId}/property-definitions. planId is the required path identifier despite the BODY PARAMETERS heading. Property type-specific fields come from Plan Property Objects; JSON remains open. See C07. Body fields: id, propertyType, name, description, helpText, default, delimiter, categories, paths, items, maxLength, minLength, units, pattern, validate. Reference: https://help.xmatters.com/xmapi/#create-plan-properties 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-plan-properties | |
| 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. |