PATCH
/
v1
/
communications
/
groups
/
{id}
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": "463a89d2-2dd2-4f48-bc66-3f6bb0e4c615",
    "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": "7ceeeca7-eba2-41a6-944c-b279ebc4814b",
      "slack_channel_ids": [
        "ca0d2171-ca85-5b58-97b0-5565a2b50583",
        "7d71adea-c720-5b36-ad48-15f919a286b0"
      ],
      "created_at": "2025-07-09T00:11:49.000-07:00",
      "updated_at": "2025-07-09T00:12:06.368-07:00",
      "team_id": 58,
      "communication_group_members": [],
      "communication_external_group_members": [
        {
          "id": "7234fd56-3674-4428-ae14-dc6bef02cdda",
          "name": "Updated External Member",
          "email": "external@example.com",
          "phone_number": "+911234567890"
        }
      ],
      "communication_group_conditions": [
        {
          "id": "9c007cc8-80c8-432e-82c9-a5d1f50c964b",
          "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

Response

200
application/vnd.api+json

communications group updated

The response is of type object.