Create a device
xmatters_create_a_deviceCreate a device in xMatters by submitting its configuration, such as type, owner, and contact details. Register new notification devices with required confirmation.
Instructions
Create a device. POST /api/xm/1/devices. Device-type-specific fields are conditional. Mobile push devices cannot be created by REST; existing push devices can be modified. Body fields and nested structures remain open. Body fields: defaultDevice, delay, deviceType, id, externalKey, externallyOwned, name, owner, priorityThreshold, provider, recipientType, sequence, status, testStatus, timeframes, emailAddress, phoneNumber, twoWayDevice, pin, country. Reference: https://help.xmatters.com/xmapi/#create-a-device 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-device | |
| 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. |