Skip to main content
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": "561072cd-ecd6-4a7b-87c3-136e3ac0f8bf",
    "type": "communications-templates",
    "attributes": {
      "name": "Updated Template Name",
      "slug": "2ms2y",
      "description": "Updated description",
      "position": 1,
      "created_at": "2025-11-06T13:20:47.456-08:00",
      "updated_at": "2025-11-06T13:20:51.907-08:00",
      "communication_type_id": "bef1fc69-0d8c-4b9f-a07b-609b3f451215",
      "communication_type": {
        "data": {
          "id": "bef1fc69-0d8c-4b9f-a07b-609b3f451215",
          "type": "communications_types",
          "attributes": {
            "name": "xeg5a",
            "slug": "xeg5a",
            "description": "Animi ratione suscipit quae.",
            "color": "#FAEBB7",
            "position": 1,
            "created_at": "2025-11-06T13:20:47.430-08:00",
            "updated_at": "2025-11-06T13:20:47.430-08:00",
            "communication_groups": [],
            "communication_templates": [
              {
                "id": "561072cd-ecd6-4a7b-87c3-136e3ac0f8bf",
                "name": "Updated Template Name"
              },
              {
                "id": "2ea9a76d-f758-45aa-9f32-acaa119996ab",
                "name": "mhmc8"
              },
              {
                "id": "a534beb3-8337-4ebf-b043-99f241bcd358",
                "name": "56izp"
              },
              {
                "id": "eb3bad4a-00a5-4d7e-8585-a5d04f9d48b4",
                "name": "jdif4"
              },
              {
                "id": "95264309-b3c6-4860-a1bb-ece817c638b1",
                "name": "7c1zl"
              },
              {
                "id": "03f0465f-8414-4ec5-9720-9a9cb5416876",
                "name": "hp1c7"
              },
              {
                "id": "25a8a534-1e90-441e-9f11-7d7d7a7474d9",
                "name": "ft032"
              },
              {
                "id": "820b8622-daf4-4476-9cd9-da782567815f",
                "name": "3cm6c"
              },
              {
                "id": "77ca385b-f3a9-46a2-9380-8da19a4840a3",
                "name": "80qwt"
              },
              {
                "id": "03640d44-ece2-4bd5-b0e0-a2b48d5c18f5",
                "name": "d71bn"
              }
            ]
          }
        }
      },
      "communication_template_stages": [
        {
          "data": {
            "id": "1f78dc9d-123b-4f8b-9604-d6d36272202c",
            "type": "communications-template_stages",
            "attributes": {
              "email_body": "Deserunt at eum possimus.",
              "email_subject": "agpfombu54",
              "slack_content": "Voluptate praesentium nihil debitis.",
              "sms_content": "Et cum sed et.",
              "created_at": "2025-11-06T13:20:47.484-08:00",
              "updated_at": "2025-11-06T13:20:47.484-08:00",
              "communication_stage": {
                "id": "4c7c34f8-3304-42f0-b49f-db31562e0597",
                "name": "buayf"
              },
              "communication_template": {
                "id": "561072cd-ecd6-4a7b-87c3-136e3ac0f8bf",
                "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
data
object
required

Response

communications template updated

data
object
required