Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/vnd.api+json
Response
communications group created
Creates a new communications group from provided data
curl --request POST \
--url https://api.rootly.com/v1/communications/groups \
--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": [
{
"property_type": "service",
"service_ids": [
"<string>"
],
"severity_ids": [
"<string>"
],
"functionality_ids": [
"<string>"
],
"group_ids": [
"<string>"
],
"incident_type_ids": [
"<string>"
]
}
],
"communication_group_members_attributes": [
{
"user_id": 123
}
],
"communication_external_group_members_attributes": [
{
"name": "<string>",
"email": "<string>",
"phone_number": "<string>"
}
]
}
}
}'
{
"data": {
"id": "2251a3b4-3c60-498b-9d18-980d6d0d4004",
"type": "communications-groups",
"attributes": {
"name": "Engineering Team",
"slug": "engineering-team",
"description": "Engineering team communications group",
"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"
],
"created_at": "2025-09-26T17:24:17.407-07:00",
"updated_at": "2025-09-26T17:24:17.407-07:00",
"team_id": 65,
"communication_group_members": [
{
"id": "b699e005-7319-4d08-bca4-878f94159035",
"user_id": 80,
"name": "Clemente Ferry",
"email": "merrie_thiel@kihn-reichel.example"
}
],
"communication_external_group_members": [
{
"id": "f9561184-8943-4bf8-9f04-244d1e24a098",
"name": "External member",
"email": "external@example.com",
"phone_number": "+911234567890"
}
],
"communication_group_conditions": [
{
"id": "b6336e14-72ce-4f95-9717-c2478328a1f0",
"condition": "is",
"property_type": "service",
"properties": [
{
"id": "f23a1ce1-1f4d-4fc1-ba56-43457ffd919b",
"name": "Assumenda ipsa qui vel."
}
]
}
]
}
}
}
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Show child attributes
communications group created
Show child attributes
Was this page helpful?
curl --request POST \
--url https://api.rootly.com/v1/communications/groups \
--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": [
{
"property_type": "service",
"service_ids": [
"<string>"
],
"severity_ids": [
"<string>"
],
"functionality_ids": [
"<string>"
],
"group_ids": [
"<string>"
],
"incident_type_ids": [
"<string>"
]
}
],
"communication_group_members_attributes": [
{
"user_id": 123
}
],
"communication_external_group_members_attributes": [
{
"name": "<string>",
"email": "<string>",
"phone_number": "<string>"
}
]
}
}
}'
{
"data": {
"id": "2251a3b4-3c60-498b-9d18-980d6d0d4004",
"type": "communications-groups",
"attributes": {
"name": "Engineering Team",
"slug": "engineering-team",
"description": "Engineering team communications group",
"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"
],
"created_at": "2025-09-26T17:24:17.407-07:00",
"updated_at": "2025-09-26T17:24:17.407-07:00",
"team_id": 65,
"communication_group_members": [
{
"id": "b699e005-7319-4d08-bca4-878f94159035",
"user_id": 80,
"name": "Clemente Ferry",
"email": "merrie_thiel@kihn-reichel.example"
}
],
"communication_external_group_members": [
{
"id": "f9561184-8943-4bf8-9f04-244d1e24a098",
"name": "External member",
"email": "external@example.com",
"phone_number": "+911234567890"
}
],
"communication_group_conditions": [
{
"id": "b6336e14-72ce-4f95-9717-c2478328a1f0",
"condition": "is",
"property_type": "service",
"properties": [
{
"id": "f23a1ce1-1f4d-4fc1-ba56-43457ffd919b",
"name": "Assumenda ipsa qui vel."
}
]
}
]
}
}
}