Replace a template's working copy

curl --request PUT \
  --url https://api.mercemur.com/api/v1/marketing-templates/{templateId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "name": "<string>",
  "subject": "<string>",
  "html_body": "<string>",
  "text_body": "<string>"
}
'

const options = {
  method: 'PUT',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: '<string>',
    subject: '<string>',
    html_body: '<string>',
    text_body: '<string>'
  })
};

fetch('https://api.mercemur.com/api/v1/marketing-templates/{templateId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.mercemur.com/api/v1/marketing-templates/{templateId}"

payload = {
    "name": "<string>",
    "subject": "<string>",
    "html_body": "<string>",
    "text_body": "<string>"
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

package main

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

func main() {

	url := "https://api.mercemur.com/api/v1/marketing-templates/{templateId}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"html_body\": \"<string>\",\n  \"text_body\": \"<string>\"\n}")

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

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	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))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mercemur.com/api/v1/marketing-templates/{templateId}",
  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>',
    'html_body' => '<string>',
    'text_body' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

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

curl_close($curl);

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

{
  "data": {
    "channel": "<string>",
    "created_at": "<string>",
    "current_version": 123,
    "current_version_id": "<string>",
    "html_body": "<string>",
    "id": "<string>",
    "name": "<string>",
    "status": "<string>",
    "subject": "<string>",
    "text_body": "<string>",
    "updated_at": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

API Reference

Replace a template's working copy

Replaces the template’s WORKING COPY. It deliberately does not touch the published version, so a campaign that already sent keeps resolving to the copy it sent; what you change here is what the NEXT publish will contain. A FULL REPLACE, WHICH IS WHY IT IS PUT. An omitted key is cleared, not kept, so all four fields are required and a missing one is a 400 naming it. On an sms or push template send "" for subject and html_body. channel is refused by name: a template’s channel is fixed at creation, and changing it would leave an HTML body on a surface that renders plain text. THERE IS NO PRECONDITION ON THIS WRITE. updated_at is published so you can detect that the merchant’s dashboard changed the template under you, but the last writer wins. If two systems author the same template, coordinate on your side.

PUT

api

marketing-templates

{templateId}

Replace a template's working copy

curl --request PUT \
  --url https://api.mercemur.com/api/v1/marketing-templates/{templateId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "name": "<string>",
  "subject": "<string>",
  "html_body": "<string>",
  "text_body": "<string>"
}
'

const options = {
  method: 'PUT',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: '<string>',
    subject: '<string>',
    html_body: '<string>',
    text_body: '<string>'
  })
};

fetch('https://api.mercemur.com/api/v1/marketing-templates/{templateId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.mercemur.com/api/v1/marketing-templates/{templateId}"

payload = {
    "name": "<string>",
    "subject": "<string>",
    "html_body": "<string>",
    "text_body": "<string>"
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

package main

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

func main() {

	url := "https://api.mercemur.com/api/v1/marketing-templates/{templateId}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"html_body\": \"<string>\",\n  \"text_body\": \"<string>\"\n}")

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

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	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))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mercemur.com/api/v1/marketing-templates/{templateId}",
  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>',
    'html_body' => '<string>',
    'text_body' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

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

curl_close($curl);

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

{
  "data": {
    "channel": "<string>",
    "created_at": "<string>",
    "current_version": 123,
    "current_version_id": "<string>",
    "html_body": "<string>",
    "id": "<string>",
    "name": "<string>",
    "status": "<string>",
    "subject": "<string>",
    "text_body": "<string>",
    "updated_at": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

Authorizations

Authorization

string

header

required

A secret API key. Publishable keys cannot reach this API. A key may carry an expiry, and an expired key is refused exactly like an unknown one, with a 401 that names no reason; check the key's expires_at in the dashboard rather than inferring it from a response. When a merchant rolls a key's secret they choose a grace window of up to 3 days, and for its duration BOTH the new secret and the one it replaced authenticate, so an integration moves over on its own deploy schedule instead of at the instant the button is pressed. Move before the window closes: after it, the old secret is refused. Nothing else about this contract moves with a roll. The key keeps its id and its scopes, so the only thing an integration updates is the credential itself.

Headers

Idempotency-Key

string

required

A unique key per logical write. Replaying a request with the same key returns the first response byte for byte instead of applying the write twice.

Path Parameters

templateId

string

required

Body

application/json

EVERY FIELD IS REQUIRED because this is a full replace: an omitted key is cleared, not kept. A client that dropped text_body would blank the plain-text alternative of the merchant's email, the next publish would snapshot the half-template, and the send would still go out with every call answering 200. Empty strings are legal and are how a non-email template says "no subject, no html". null is not: send "" to clear a field. channel is refused by name. A template's channel is fixed at creation, and changing it would leave an html body on a surface that renders plain text.

name

string

required

Still unique per store; a clash is 409 name_taken.

subject

string

required

Email only. Send "" on an sms or push template; a non-empty value there is 400 subject_not_allowed.

html_body

string

required

Email only, stored verbatim. Send "" on an sms or push template; a non-empty value there is 400 html_not_allowed.

text_body

string

required

Stored verbatim. Same closed merge-tag vocabulary as the create, so a body carrying an unknown tag is refused rather than delivered with a hole in it.

Response

Success

data

object

Show child attributes

Overview

Endpoints

Replace a template's working copy

Authorizations

Headers

Path Parameters

Body

Response