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": "13219636-3268-45f7-88ac-9d3386425e6e",
    "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": "2d8b6166-a6e5-4ec3-be40-f3b5a7df5dc3",
      "slack_channel_ids": [
        "7689fd30-d999-51de-8c67-a4223fcbd521",
        "88fcdb5a-c3bb-5149-aa0c-44ba27e315ea"
      ],
      "created_at": "2025-10-18T00:48:35.656-07:00",
      "updated_at": "2025-10-18T00:48:50.627-07:00",
      "team_id": 67,
      "communication_group_members": [],
      "communication_external_group_members": [
        {
          "id": "1a6f3565-1c16-4c8b-8e2d-42eb2ca9de14",
          "name": "Updated External Member",
          "email": "external@example.com",
          "phone_number": "+911234567890"
        }
      ],
      "communication_group_conditions": [
        {
          "id": "3466fd95-df04-4b56-a2d5-ab1e2503e776",
          "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
I