Create a form section
xmatters_create_a_form_sectionCreate a form section in xMatters by sending formId and body JSON. Add customizable sections for incident details, recipient responses, and escalation settings.
Instructions
Create a form section. POST /api/xm/1/forms/{formId}/sections. Body is a form-section object; section-specific fields and Incident Details fields remain open. Only one section per request. Body fields: id, form, title, type, visible, collapsed, orderNum, bridgeType, properties, targetDeviceNames, otherResponseCountThreshold, priority, expiration, expirationInMinutes, overrideDeviceRestrictions, escalationOverride, bypassPhoneIntro, requirePhonePassword, voicemailOptions, recipients, enableResponseCount, responseCountThreshold, searchableTypes, expandableGroups, callerId, displayName. Reference: https://help.xmatters.com/xmapi/#create-a-form-section 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-form-section | |
| 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. |