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": "e1a32195-3e68-40d5-94a7-44d8c5a8d28c",
    "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": "1fbc9afd-763e-453d-843e-e10a67083c91",
      "slack_channel_ids": [
        "3e901406-7217-50e5-84a1-fd992a870b82",
        "b9d1c2e5-f189-533d-801c-883fe4f49a66"
      ],
      "created_at": "2025-12-19T12:26:33.569-08:00",
      "updated_at": "2025-12-19T12:26:45.518-08:00",
      "team_id": 137,
      "member_ids": [],
      "communication_group_members": [],
      "communication_external_group_members": [
        {
          "id": "6811a125-e77a-422c-a1d5-65e00e4f937a",
          "name": "Updated External Member",
          "email": "[email protected]",
          "phone_number": "+911234567890"
        }
      ],
      "communication_group_conditions": [
        {
          "id": "ec927004-c87b-4cc2-aa53-915724724021",
          "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