Skip to main content
PATCH
/
v1
/
communications
/
groups
/
{id}
Updates a communications group
curl --request PATCH \
  --url https://api.rootly.com/v1/communications/groups/{id} \
  --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": [
        {
          "id": "<string>",
          "property_type": "service",
          "service_ids": [
            "<string>"
          ],
          "severity_ids": [
            "<string>"
          ],
          "functionality_ids": [
            "<string>"
          ],
          "group_ids": [
            "<string>"
          ],
          "incident_type_ids": [
            "<string>"
          ]
        }
      ],
      "communication_group_members_attributes": [
        {
          "id": "<string>",
          "user_id": 123
        }
      ],
      "communication_external_group_members_attributes": [
        {
          "id": "<string>",
          "name": "<string>",
          "email": "<string>",
          "phone_number": "<string>"
        }
      ]
    }
  }
}'
{
  "data": {
    "id": "fdb8551d-ec57-4aea-8eaa-689d144d6ddf",
    "type": "communications-groups",
    "attributes": {
      "name": "Updated Group Name",
      "slug": "communication-group-1",
      "description": "Updated description",
      "is_private": false,
      "condition_type": "any",
      "email_channel": true,
      "sms_channel": false,
      "communication_type_id": "4cc3f907-34bb-4ea0-8df3-5924414678b2",
      "slack_channel_ids": [
        "5c8e0c0f-637b-5a66-8d7b-dfb2b1c9d994",
        "242021da-b050-59bf-87ff-7e46e3cceebe"
      ],
      "created_at": "2025-11-27T00:06:29.536-08:00",
      "updated_at": "2025-11-27T00:06:43.627-08:00",
      "team_id": 110,
      "communication_group_members": [],
      "communication_external_group_members": [
        {
          "id": "fbe8ff40-dab6-4cfb-9268-f7338c17d167",
          "name": "Updated External Member",
          "email": "external@example.com",
          "phone_number": "+911234567890"
        }
      ],
      "communication_group_conditions": [
        {
          "id": "8923159f-6430-423a-a39c-78eb0a6e0cc3",
          "condition": "is",
          "property_type": "service",
          "properties": []
        }
      ]
    }
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Communications Group ID

Body

application/vnd.api+json
​
data
object
required

Response

communications group updated

​
data
object
required