PATCH
/
v1
/
communications
/
templates
/
{id}
Updates a communications template
curl --request PATCH \
  --url https://api.rootly.com/v1/communications/templates/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '{
  "data": {
    "type": "communications-templates",
    "attributes": {
      "name": "<string>",
      "description": "<string>",
      "communication_type_id": "<string>",
      "position": 123,
      "communication_template_stages_attributes": [
        {
          "id": "<string>",
          "sms_content": "<string>",
          "email_subject": "<string>",
          "email_body": "<string>",
          "slack_content": "<string>"
        }
      ]
    }
  }
}'
{
  "data": {
    "id": "1b957412-c8ca-4263-9f91-c8869b6379d5",
    "type": "communications-templates",
    "attributes": {
      "name": "Updated Template Name",
      "slug": "62r10",
      "description": "Updated description",
      "position": 1,
      "created_at": "2025-07-29T05:35:52.732-07:00",
      "updated_at": "2025-07-29T05:35:56.172-07:00",
      "communication_type_id": "2b9344ec-0331-4bc2-b37a-f3bf358ab2b2",
      "communication_type": {
        "data": {
          "id": "2b9344ec-0331-4bc2-b37a-f3bf358ab2b2",
          "type": "communications_types",
          "attributes": {
            "name": "0ti9c",
            "slug": "0ti9c",
            "description": "Corrupti alias earum aut.",
            "color": "#F5D9C4",
            "position": 1,
            "created_at": "2025-07-29T05:35:52.719-07:00",
            "updated_at": "2025-07-29T05:35:52.719-07:00",
            "communication_groups": [],
            "communication_templates": [
              {
                "id": "1b957412-c8ca-4263-9f91-c8869b6379d5",
                "name": "Updated Template Name"
              },
              {
                "id": "723fd544-9c3d-425f-992d-1d1282d2a1c6",
                "name": "2jr8y"
              },
              {
                "id": "515bda7b-44af-4a45-8215-5c9f66d559db",
                "name": "qeh1h"
              },
              {
                "id": "0333095b-cd3f-4424-99b0-083a6acd6427",
                "name": "ukbk3"
              },
              {
                "id": "2b08ef47-35ab-421f-8f97-36313c7b72ec",
                "name": "4ri18"
              },
              {
                "id": "359096be-bd00-40c8-848b-2ee8037dbf9c",
                "name": "81vib"
              },
              {
                "id": "016a1d29-bcc2-4383-949a-d12a8622d5c0",
                "name": "6x9o9"
              },
              {
                "id": "aaf5dfd0-04de-4025-b635-786a0498b35a",
                "name": "tyi0n"
              },
              {
                "id": "14d95114-bfd1-43fd-9589-883847206108",
                "name": "dcyq8"
              },
              {
                "id": "d8020dd9-32b7-4d6b-8b79-df7c21733659",
                "name": "c3tio"
              }
            ]
          }
        }
      },
      "communication_template_stages": [
        {
          "data": {
            "id": "ea77e201-aeb9-4e37-8167-6630abae1d96",
            "type": "communications-template_stages",
            "attributes": {
              "email_body": "Consequatur et architecto quos.",
              "email_subject": "r3sxa2wd3w",
              "slack_content": "Dolor et voluptate qui.",
              "sms_content": "Occaecati aliquam accusamus consequatur.",
              "created_at": "2025-07-29T05:35:52.745-07:00",
              "updated_at": "2025-07-29T05:35:52.745-07:00",
              "communication_stage": {
                "id": "fe7a5241-ad0d-4c47-b3c6-0c53deed2449",
                "name": "4dd1y"
              },
              "communication_template": {
                "id": "1b957412-c8ca-4263-9f91-c8869b6379d5",
                "name": "Updated Template Name"
              }
            }
          }
        }
      ]
    }
  }
}

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 Template ID

Body

application/vnd.api+json

Response

200
application/vnd.api+json

communications template updated

The response is of type object.