Skip to main content
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": "de506ef9-11be-4344-b4d7-ff5d349a661c",
    "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": "4cc3f907-34bb-4ea0-8df3-5924414678b2",
      "slack_channel_ids": [
        "5c8e0c0f-637b-5a66-8d7b-dfb2b1c9d994"
      ],
      "created_at": "2025-11-27T00:06:42.911-08:00",
      "updated_at": "2025-11-27T00:06:42.911-08:00",
      "team_id": 110,
      "communication_group_members": [
        {
          "id": "e90deea1-3707-4cca-a2cd-e39fa88fa9b0",
          "user_id": 109,
          "name": "Deb Smith",
          "email": "britt@terry.test"
        }
      ],
      "communication_external_group_members": [
        {
          "id": "0d076a9f-3879-4ff4-843d-90d5451e1425",
          "name": "External member",
          "email": "external@example.com",
          "phone_number": "+911234567890"
        }
      ],
      "communication_group_conditions": [
        {
          "id": "537932b1-0bfc-4495-a0bd-a3e9a7a4c7f2",
          "condition": "is",
          "property_type": "service",
          "properties": [
            {
              "id": "8e5ae257-2d38-4eb3-afcd-d48b8be2b78a",
              "name": "Nisi et incidunt quos."
            }
          ]
        }
      ]
    }
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/vnd.api+json
​
data
object
required

Response

communications group created

​
data
object
required