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": "dd9815cb-d0d7-44a0-a069-e263eb47979b",
    "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": "7d181223-225f-43b0-9f1d-b0af6c70b075",
      "slack_channel_ids": [
        "f6c07d90-5924-5b4c-85e7-840f0f958f4f"
      ],
      "created_at": "2026-02-18T05:11:48.704-08:00",
      "updated_at": "2026-02-18T05:11:48.704-08:00",
      "team_id": 201,
      "member_ids": [
        208
      ],
      "communication_group_members": [
        {
          "id": "3a5231be-2ee2-4ed1-ac95-065442b5bdc7",
          "user_id": 208,
          "name": "Emilio Boyer",
          "email": "andre_mills@thiel.test"
        }
      ],
      "communication_external_group_members": [
        {
          "id": "2bbb762b-dbcf-47b2-836f-f31d74fa14d3",
          "name": "External member",
          "email": "external@example.com",
          "phone_number": "+911234567890"
        }
      ],
      "communication_group_conditions": [
        {
          "id": "e9bba3b5-0a0a-44c2-96df-a3b8b997e45d",
          "condition": "is",
          "property_type": "service",
          "service_ids": [
            "c76f8992-5789-49b4-b9ff-85755cc7009b"
          ],
          "severity_ids": [],
          "functionality_ids": [],
          "group_ids": [],
          "incident_type_ids": [],
          "properties": [
            {
              "id": "c76f8992-5789-49b4-b9ff-85755cc7009b",
              "name": "Aliquam aut possimus necessitatibus."
            }
          ]
        }
      ]
    }
  }
}

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