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": "ac54ef3a-c7b2-4316-aac5-9c694760204d",
    "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": "0a3d13e9-0afa-4312-8d3e-578aff3c7c23",
      "slack_channel_ids": [
        "c4992a74-8633-5ded-9d12-8a59241c9111",
        "d784892e-697e-5d03-855d-9d652e6c05bd"
      ],
      "created_at": "2026-01-29T00:03:11.299-08:00",
      "updated_at": "2026-01-29T00:03:20.629-08:00",
      "team_id": 138,
      "member_ids": [],
      "communication_group_members": [],
      "communication_external_group_members": [
        {
          "id": "a0479300-1886-42f0-8ced-385cbb25324a",
          "name": "Updated External Member",
          "email": "[email protected]",
          "phone_number": "+911234567890"
        }
      ],
      "communication_group_conditions": [
        {
          "id": "e5a7db04-3424-45e0-849c-f6f70c6ca607",
          "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