Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Communications Group ID
Body
application/vnd.api+json
Response
communications group updated
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": "e039adc9-fa9c-45e9-823f-e83bba88c0a1",
"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": "ca09e9d0-5f3c-4971-8dc8-77555384c268",
"slack_channel_ids": [
"760ee423-372c-5db1-be7b-2fd10e10317b",
"7b642b4e-bf99-586f-b808-7f67f7a2793f"
],
"created_at": "2025-11-06T13:20:13.767-08:00",
"updated_at": "2025-11-06T13:20:37.413-08:00",
"team_id": 108,
"communication_group_members": [],
"communication_external_group_members": [
{
"id": "18dc66f9-6be4-4b4e-bd0c-340af83425da",
"name": "Updated External Member",
"email": "external@example.com",
"phone_number": "+911234567890"
}
],
"communication_group_conditions": [
{
"id": "7bc8112b-6f25-40a4-9bb8-b79845a1b195",
"condition": "is",
"property_type": "service",
"properties": []
}
]
}
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Communications Group ID
Show child attributes
communications group updated
Show child attributes
Was this page helpful?
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": "e039adc9-fa9c-45e9-823f-e83bba88c0a1",
"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": "ca09e9d0-5f3c-4971-8dc8-77555384c268",
"slack_channel_ids": [
"760ee423-372c-5db1-be7b-2fd10e10317b",
"7b642b4e-bf99-586f-b808-7f67f7a2793f"
],
"created_at": "2025-11-06T13:20:13.767-08:00",
"updated_at": "2025-11-06T13:20:37.413-08:00",
"team_id": 108,
"communication_group_members": [],
"communication_external_group_members": [
{
"id": "18dc66f9-6be4-4b4e-bd0c-340af83425da",
"name": "Updated External Member",
"email": "external@example.com",
"phone_number": "+911234567890"
}
],
"communication_group_conditions": [
{
"id": "7bc8112b-6f25-40a4-9bb8-b79845a1b195",
"condition": "is",
"property_type": "service",
"properties": []
}
]
}
}
}