Modify plan properties
xmatters_modify_plan_propertiesUpdate plan property definitions in xMatters by sending a modified API payload. Change fields like name, help text, validation, or categories to adjust how plan properties behave.
Instructions
Modify plan properties. POST /api/xm/1/plans/{planId}/property-definitions. Body fields: id, propertyType, name, description, helpText, default, delimiter, categories, paths, items, maxLength, minLength, units, pattern, validate. Reference: https://help.xmatters.com/xmapi/#modify-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/#modify-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. |