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": "eb0aa8b1-71d3-4db6-a2e1-5b7430a9a809",
    "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": "9a95029d-b911-45ef-9351-cf1417c4d667",
      "slack_channel_ids": [
        "2621aa3f-2068-546e-977c-480d58685e88"
      ],
      "created_at": "2025-10-18T10:24:43.554-07:00",
      "updated_at": "2025-10-18T10:24:43.554-07:00",
      "team_id": 67,
      "communication_group_members": [
        {
          "id": "829b5c05-1eff-4b7d-bc62-0dec1216cc7e",
          "user_id": 106,
          "name": "Juliane Shanahan",
          "email": "denver.hettinger@wyman.test"
        }
      ],
      "communication_external_group_members": [
        {
          "id": "6eff26e9-ab66-49c0-86a8-ece4e05d9b63",
          "name": "External member",
          "email": "external@example.com",
          "phone_number": "+911234567890"
        }
      ],
      "communication_group_conditions": [
        {
          "id": "09ed5125-98be-43c2-8f4a-ca4494a2447b",
          "condition": "is",
          "property_type": "service",
          "properties": [
            {
              "id": "fda15f6e-0635-4eb5-904e-8434d632e770",
              "name": "Sunt magnam rerum qui."
            }
          ]
        }
      ]
    }
  }
}

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
I