POST
/
v1
/
communications
/
groups
Creates a communications group
curl --request POST \
  --url https://api.rootly.com/v1/communications/groups \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '{
  "data": {
    "type": "communications-groups",
    "attributes": {
      "name": "<string>",
      "description": "<string>",
      "communication_type_id": "<string>",
      "is_private": true,
      "condition_type": "any",
      "sms_channel": true,
      "email_channel": true,
      "slack_channel_ids": [
        "<string>"
      ],
      "communication_group_conditions_attributes": [
        {
          "property_type": "service",
          "service_ids": [
            "<string>"
          ],
          "severity_ids": [
            "<string>"
          ],
          "functionality_ids": [
            "<string>"
          ],
          "group_ids": [
            "<string>"
          ],
          "incident_type_ids": [
            "<string>"
          ]
        }
      ],
      "communication_group_members_attributes": [
        {
          "user_id": 123
        }
      ],
      "communication_external_group_members_attributes": [
        {
          "name": "<string>",
          "email": "<string>",
          "phone_number": "<string>"
        }
      ]
    }
  }
}'
{
  "data": {
    "id": "42d8a21a-9d13-4516-b824-d7a125b01c08",
    "type": "communications-groups",
    "attributes": {
      "name": "Engineering Team",
      "slug": "engineering-team",
      "description": "Engineering team communications group",
      "is_private": false,
      "condition_type": "any",
      "email_channel": true,
      "sms_channel": false,
      "communication_type_id": "da2df13c-dfe9-4938-aeab-93467df96ae4",
      "slack_channel_ids": [
        "d176d26d-e123-5866-89e7-a5f0c549157e"
      ],
      "created_at": "2025-09-07T18:19:09.011-07:00",
      "updated_at": "2025-09-07T18:19:09.011-07:00",
      "team_id": 65,
      "communication_group_members": [
        {
          "id": "3e92b7f0-e3f5-468b-81de-f57ebc1be317",
          "user_id": 80,
          "name": "Joanne Schmidt",
          "email": "alma@leuschke-smitham.example"
        }
      ],
      "communication_external_group_members": [
        {
          "id": "619f5818-0fc6-4850-83c6-42564852e79f",
          "name": "External member",
          "email": "external@example.com",
          "phone_number": "+911234567890"
        }
      ],
      "communication_group_conditions": [
        {
          "id": "a1814479-914c-43f4-a0fb-55f3190e3814",
          "condition": "is",
          "property_type": "service",
          "properties": [
            {
              "id": "1e400eaf-2319-4465-b2bd-7b4aa5eb4f05",
              "name": "Et cumque numquam omnis."
            }
          ]
        }
      ]
    }
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/vnd.api+json

Response

201
application/vnd.api+json

communications group created

The response is of type object.