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>"
        }
      ]
    }
  }
}
'
import requests

url = "https://api.rootly.com/v1/communications/templates/{id}"

payload = { "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>"
}
]
}
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/vnd.api+json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/vnd.api+json'},
body: JSON.stringify({
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>'
}
]
}
}
})
};

fetch('https://api.rootly.com/v1/communications/templates/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.rootly.com/v1/communications/templates/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'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>'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/vnd.api+json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.rootly.com/v1/communications/templates/{id}"

payload := strings.NewReader("{\n \"data\": {\n \"type\": \"communications_templates\",\n \"attributes\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"communication_type_id\": \"<string>\",\n \"position\": 123,\n \"communication_template_stages_attributes\": [\n {\n \"id\": \"<string>\",\n \"sms_content\": \"<string>\",\n \"email_subject\": \"<string>\",\n \"email_body\": \"<string>\",\n \"slack_content\": \"<string>\"\n }\n ]\n }\n }\n}")

req, _ := http.NewRequest("PATCH", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/vnd.api+json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://api.rootly.com/v1/communications/templates/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/vnd.api+json")
.body("{\n \"data\": {\n \"type\": \"communications_templates\",\n \"attributes\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"communication_type_id\": \"<string>\",\n \"position\": 123,\n \"communication_template_stages_attributes\": [\n {\n \"id\": \"<string>\",\n \"sms_content\": \"<string>\",\n \"email_subject\": \"<string>\",\n \"email_body\": \"<string>\",\n \"slack_content\": \"<string>\"\n }\n ]\n }\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.rootly.com/v1/communications/templates/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/vnd.api+json'
request.body = "{\n \"data\": {\n \"type\": \"communications_templates\",\n \"attributes\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"communication_type_id\": \"<string>\",\n \"position\": 123,\n \"communication_template_stages_attributes\": [\n {\n \"id\": \"<string>\",\n \"sms_content\": \"<string>\",\n \"email_subject\": \"<string>\",\n \"email_body\": \"<string>\",\n \"slack_content\": \"<string>\"\n }\n ]\n }\n }\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "id": "<string>",
    "type": "communications_templates",
    "attributes": {
      "name": "<string>",
      "position": 123,
      "created_at": "<string>",
      "updated_at": "<string>",
      "slug": "<string>",
      "description": "<string>",
      "communication_type_id": "<string>",
      "communication_template_stages": [
        {
          "data": {
            "id": "<string>",
            "type": "communications_template_stages",
            "attributes": {
              "email_body": "<string>",
              "email_subject": "<string>",
              "slack_content": "<string>",
              "sms_content": "<string>",
              "created_at": "<string>",
              "updated_at": "<string>",
              "communication_stage": {
                "id": "<string>",
                "name": "<string>"
              },
              "communication_template": {
                "id": "<string>",
                "name": "<string>"
              }
            }
          }
        }
      ],
      "communication_type": {
        "id": "<string>",
        "name": "<string>"
      }
    }
  },
  "included": [
    {
      "id": "<string>",
      "type": "<string>",
      "attributes": {},
      "relationships": {}
    }
  ]
}
{
"errors": [
{
"title": "<string>",
"status": "<string>",
"code": "<string>",
"detail": "<string>"
}
]
}

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
included
object[]