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>",
      "communication_type_id": "<string>",
      "description": "<string>",
      "is_private": true,
      "condition_type": "any",
      "sms_channel": true,
      "email_channel": true,
      "member_ids": [
        123
      ],
      "slack_channel_ids": [
        "<string>"
      ],
      "communication_group_conditions": [
        {
          "property_type": "service",
          "service_ids": [
            "<string>"
          ],
          "severity_ids": [
            "<string>"
          ],
          "functionality_ids": [
            "<string>"
          ],
          "group_ids": [
            "<string>"
          ],
          "incident_type_ids": [
            "<string>"
          ]
        }
      ],
      "communication_external_group_members": [
        {
          "name": "<string>",
          "email": "<string>",
          "phone_number": "<string>"
        }
      ]
    }
  }
}
'
{
  "data": {
    "id": "7d55adc5-5616-431a-b174-4044a1c55dff",
    "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": "1fbc9afd-763e-453d-843e-e10a67083c91",
      "slack_channel_ids": [
        "3e901406-7217-50e5-84a1-fd992a870b82"
      ],
      "created_at": "2025-12-19T12:26:44.938-08:00",
      "updated_at": "2025-12-19T12:26:44.938-08:00",
      "team_id": 137,
      "member_ids": [
        112
      ],
      "communication_group_members": [
        {
          "id": "ac7edf18-27a8-4155-8325-4b563ab50c7a",
          "user_id": 112,
          "name": "Nicolasa Raynor",
          "email": "[email protected]"
        }
      ],
      "communication_external_group_members": [
        {
          "id": "384e4b69-667b-4399-966f-76310aebd6f0",
          "name": "External member",
          "email": "[email protected]",
          "phone_number": "+911234567890"
        }
      ],
      "communication_group_conditions": [
        {
          "id": "691d625c-c06b-45bb-8c40-47c7bec15fb0",
          "condition": "is",
          "property_type": "service",
          "service_ids": [
            "be013ab2-4455-445e-9592-0a10259d09d8"
          ],
          "severity_ids": [],
          "functionality_ids": [],
          "group_ids": [],
          "incident_type_ids": [],
          "properties": [
            {
              "id": "be013ab2-4455-445e-9592-0a10259d09d8",
              "name": "Error exercitationem voluptatibus veritatis."
            }
          ]
        }
      ]
    }
  }
}

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