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": "2e5f57b9-37e9-4230-bec2-3fdf5246d3f3",
    "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": "e5860e2e-1a2e-4138-9ef5-02bff059aa27",
      "slack_channel_ids": [
        "18a7fea0-ad92-5206-adad-0ed574a2f906"
      ],
      "created_at": "2025-12-19T13:50:50.883-08:00",
      "updated_at": "2025-12-19T13:50:50.883-08:00",
      "team_id": 137,
      "member_ids": [
        112
      ],
      "communication_group_members": [
        {
          "id": "c7c2537f-83b0-43b9-80b0-9897f159e417",
          "user_id": 112,
          "name": "Belle Schaefer",
          "email": "[email protected]"
        }
      ],
      "communication_external_group_members": [
        {
          "id": "7b74b735-481a-4b38-8c66-8073f565cebc",
          "name": "External member",
          "email": "[email protected]",
          "phone_number": "+911234567890"
        }
      ],
      "communication_group_conditions": [
        {
          "id": "bf7e2636-6a6a-48b8-b503-2cab38caf0dd",
          "condition": "is",
          "property_type": "service",
          "service_ids": [
            "a3381072-3393-4167-8261-f50beab56bf9"
          ],
          "severity_ids": [],
          "functionality_ids": [],
          "group_ids": [],
          "incident_type_ids": [],
          "properties": [
            {
              "id": "a3381072-3393-4167-8261-f50beab56bf9",
              "name": "Nulla tenetur consequuntur et."
            }
          ]
        }
      ]
    }
  }
}

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