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": "ba37ac9b-1030-4a6b-8921-1380c7869dca",
"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": "0a866b70-9fa9-4c70-b8f2-7513415a36b6",
"slack_channel_ids": [
"f42d3cd3-435e-5530-8f78-a75cbb617eee",
"3b5a518f-8ae5-516f-9c1e-74b505ca5eb4"
],
"created_at": "2025-09-26T17:24:04.583-07:00",
"updated_at": "2025-09-26T17:24:18.169-07:00",
"team_id": 65,
"communication_group_members": [],
"communication_external_group_members": [
{
"id": "c9eee8f1-72d1-4e1f-ad53-7606d0b19f49",
"name": "Updated External Member",
"email": "external@example.com",
"phone_number": "+911234567890"
}
],
"communication_group_conditions": [
{
"id": "c7e8c23a-d7cc-4437-bbab-d913b8369b47",
"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": "ba37ac9b-1030-4a6b-8921-1380c7869dca",
"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": "0a866b70-9fa9-4c70-b8f2-7513415a36b6",
"slack_channel_ids": [
"f42d3cd3-435e-5530-8f78-a75cbb617eee",
"3b5a518f-8ae5-516f-9c1e-74b505ca5eb4"
],
"created_at": "2025-09-26T17:24:04.583-07:00",
"updated_at": "2025-09-26T17:24:18.169-07:00",
"team_id": 65,
"communication_group_members": [],
"communication_external_group_members": [
{
"id": "c9eee8f1-72d1-4e1f-ad53-7606d0b19f49",
"name": "Updated External Member",
"email": "external@example.com",
"phone_number": "+911234567890"
}
],
"communication_group_conditions": [
{
"id": "c7e8c23a-d7cc-4437-bbab-d913b8369b47",
"condition": "is",
"property_type": "service",
"properties": []
}
]
}
}
}