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": "6a8770e0-570e-42dd-995e-c8fa508ef5d3",
"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": "5c1a1037-70dd-4c06-a30e-34921c160d1c",
"slack_channel_ids": [
"ad739492-60e0-5f12-af75-a5ed17c7c60b",
"d0c397ba-2c7c-5be4-8a59-8983fd90df4c"
],
"created_at": "2025-07-29T05:35:28.941-07:00",
"updated_at": "2025-07-29T05:35:46.363-07:00",
"team_id": 58,
"communication_group_members": [],
"communication_external_group_members": [
{
"id": "ad266e5c-0500-4683-b4a3-cce52c16283f",
"name": "Updated External Member",
"email": "external@example.com",
"phone_number": "+911234567890"
}
],
"communication_group_conditions": [
{
"id": "504ea1f0-d09d-46d0-abc2-c80fcd70ac85",
"condition": "is",
"property_type": "service",
"properties": []
}
]
}
}
}
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Communications Group ID
communications group updated
The response is of type object
.
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": "6a8770e0-570e-42dd-995e-c8fa508ef5d3",
"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": "5c1a1037-70dd-4c06-a30e-34921c160d1c",
"slack_channel_ids": [
"ad739492-60e0-5f12-af75-a5ed17c7c60b",
"d0c397ba-2c7c-5be4-8a59-8983fd90df4c"
],
"created_at": "2025-07-29T05:35:28.941-07:00",
"updated_at": "2025-07-29T05:35:46.363-07:00",
"team_id": 58,
"communication_group_members": [],
"communication_external_group_members": [
{
"id": "ad266e5c-0500-4683-b4a3-cce52c16283f",
"name": "Updated External Member",
"email": "external@example.com",
"phone_number": "+911234567890"
}
],
"communication_group_conditions": [
{
"id": "504ea1f0-d09d-46d0-abc2-c80fcd70ac85",
"condition": "is",
"property_type": "service",
"properties": []
}
]
}
}
}