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,
      "member_ids": [
        123
      ],
      "slack_channel_ids": [
        "<string>"
      ],
      "communication_group_conditions": [
        {
          "id": "<string>",
          "property_type": "service",
          "service_ids": [
            "<string>"
          ],
          "severity_ids": [
            "<string>"
          ],
          "functionality_ids": [
            "<string>"
          ],
          "group_ids": [
            "<string>"
          ],
          "incident_type_ids": [
            "<string>"
          ]
        }
      ],
      "communication_external_group_members": [
        {
          "id": "<string>",
          "name": "<string>",
          "email": "<string>",
          "phone_number": "<string>"
        }
      ]
    }
  }
}
'
{
  "data": {
    "id": "a6699a1e-d195-4292-aadb-2c49f63f852b",
    "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": "9ab9f77e-381e-4a15-9a22-0bd6e75656e1",
      "slack_channel_ids": [
        "b1991148-507d-5339-af45-6f40a8331362",
        "d3b819de-9c33-5711-9766-05cf23b9591e"
      ],
      "created_at": "2026-01-08T17:50:21.345-08:00",
      "updated_at": "2026-01-08T17:50:30.690-08:00",
      "team_id": 135,
      "member_ids": [],
      "communication_group_members": [],
      "communication_external_group_members": [
        {
          "id": "5ec20173-6239-49b2-acdc-27c051a8d64d",
          "name": "Updated External Member",
          "email": "[email protected]",
          "phone_number": "+911234567890"
        }
      ],
      "communication_group_conditions": [
        {
          "id": "79918924-2b3e-4e31-9369-88e261e712da",
          "condition": "is",
          "property_type": "service",
          "service_ids": [],
          "severity_ids": [],
          "functionality_ids": [],
          "group_ids": [],
          "incident_type_ids": [],
          "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