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": "3f4efbbf-5ab1-4451-ab69-420f44dd2434",
    "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": "5c1a1037-70dd-4c06-a30e-34921c160d1c",
      "slack_channel_ids": [
        "ad739492-60e0-5f12-af75-a5ed17c7c60b"
      ],
      "created_at": "2025-07-29T05:35:45.456-07:00",
      "updated_at": "2025-07-29T05:35:45.456-07:00",
      "team_id": 58,
      "communication_group_members": [
        {
          "id": "79e85662-2061-499f-bf68-ee3b84050429",
          "user_id": 64,
          "name": "Georgianne Kris",
          "email": "laurence.mayert@dicki.example"
        }
      ],
      "communication_external_group_members": [
        {
          "id": "eddc9888-578a-490e-8a36-abe7dd11097d",
          "name": "External member",
          "email": "external@example.com",
          "phone_number": "+911234567890"
        }
      ],
      "communication_group_conditions": [
        {
          "id": "68cb8177-6fc4-453d-a3b5-5351ad374740",
          "condition": "is",
          "property_type": "service",
          "properties": [
            {
              "id": "3fea9b8e-0bff-4ba6-87e3-dcc29c038376",
              "name": "Nisi impedit pariatur ut."
            }
          ]
        }
      ]
    }
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/vnd.api+json

Response

201
application/vnd.api+json

communications group created

The response is of type object.