Put v1emailtemplates

PUT /v1/email/templates/{template}

cURL

cURL

curl --request PUT \
  --url https://api.comm.com/api/v1/email/templates/{template} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "subject": "<string>",
  "body": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "<string>",
  "updated_at": "<string>",
  "meta": {
    "instruction": "<string>",
    "max_times_used": 123,
    "texts_in_rotation": 123
  },
  "is_active": true
}
'

import requests

url = "https://api.comm.com/api/v1/email/templates/{template}"

payload = {
    "name": "<string>",
    "subject": "<string>",
    "body": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "<string>",
    "updated_at": "<string>",
    "meta": {
        "instruction": "<string>",
        "max_times_used": 123,
        "texts_in_rotation": 123
    },
    "is_active": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    subject: '<string>',
    body: JSON.stringify('<string>'),
    id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    created_at: '<string>',
    updated_at: '<string>',
    meta: {instruction: '<string>', max_times_used: 123, texts_in_rotation: 123},
    is_active: true
  })
};

fetch('https://api.comm.com/api/v1/email/templates/{template}', 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.comm.com/api/v1/email/templates/{template}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'subject' => '<string>',
    'body' => '<string>',
    'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'created_at' => '<string>',
    'updated_at' => '<string>',
    'meta' => [
        'instruction' => '<string>',
        'max_times_used' => 123,
        'texts_in_rotation' => 123
    ],
    'is_active' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/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.comm.com/api/v1/email/templates/{template}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"body\": \"<string>\",\n  \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"created_at\": \"<string>\",\n  \"updated_at\": \"<string>\",\n  \"meta\": {\n    \"instruction\": \"<string>\",\n    \"max_times_used\": 123,\n    \"texts_in_rotation\": 123\n  },\n  \"is_active\": true\n}")

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

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

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.comm.com/api/v1/email/templates/{template}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"body\": \"<string>\",\n  \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"created_at\": \"<string>\",\n  \"updated_at\": \"<string>\",\n  \"meta\": {\n    \"instruction\": \"<string>\",\n    \"max_times_used\": 123,\n    \"texts_in_rotation\": 123\n  },\n  \"is_active\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.comm.com/api/v1/email/templates/{template}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"body\": \"<string>\",\n  \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"created_at\": \"<string>\",\n  \"updated_at\": \"<string>\",\n  \"meta\": {\n    \"instruction\": \"<string>\",\n    \"max_times_used\": 123,\n    \"texts_in_rotation\": 123\n  },\n  \"is_active\": true\n}"

response = http.request(request)
puts response.read_body

200

{
  "id": "<string>",
  "team_id": "<string>",
  "name": "<string>",
  "subject": "<string>",
  "body": "<string>",
  "type": "<string>",
  "meta": [
    "<unknown>"
  ],
  "is_active": true,
  "deleted_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>",
  "errors": {}
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

template · string<uuid> · required

The template ID

Body

application/json

EmailCampaignTemplateDataRequest

name · string · required

subject · string · required

body · string · required

id · string<uuid> | null

created_at · string | null

updated_at · string | null

type · enum<string> | null

Available options: manual, generated

meta · EmailCampaignTemplateMetaDataRequest · object | null

Show child attributes

is_active · boolean · default: true

Response

200

application/json

id · string · required

team_id · string · required

name · string · required

subject · string · required

body · string · required

type · string | null · required

meta · any[] | null · required

is_active · boolean · required

deleted_at · string<date-time> | null · required

created_at · string<date-time> | null · required

updated_at · string<date-time> | null · required