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": "8b72e4dc-02a9-44f7-987e-088b4419023a",
    "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": "c1f33e39-9cf3-4ef0-82ec-7bf453cdd17c",
      "slack_channel_ids": [
        "4db00867-3b86-5b19-851b-c28220785393"
      ],
      "created_at": "2025-11-28T18:07:55.153-08:00",
      "updated_at": "2025-11-28T18:07:55.153-08:00",
      "team_id": 110,
      "communication_group_members": [
        {
          "id": "2c6b54e9-fbc7-4559-9a41-9c749dc72d4d",
          "user_id": 109,
          "name": "Virginia O'Connell",
          "email": "[email protected]"
        }
      ],
      "communication_external_group_members": [
        {
          "id": "a41fdc91-dd90-41fc-a0a5-9986197a8972",
          "name": "External member",
          "email": "[email protected]",
          "phone_number": "+911234567890"
        }
      ],
      "communication_group_conditions": [
        {
          "id": "9a8525f3-fce7-4542-8d56-47b9340ed12c",
          "condition": "is",
          "property_type": "service",
          "properties": [
            {
              "id": "d2269312-9593-4ee2-b5cd-4dc9bc195e3c",
              "name": "Ut voluptatem sed porro."
            }
          ]
        }
      ]
    }
  }
}

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