Update a message template

1 min

POST

https://api.campaign.episerver.net/rest/{clientId}/messagetemplates/{messageTemplateId}

Update information of a message template, such as name or subject.

Path Parameters

clientIdstringrequired
Description
Client ID
messageTemplateIdinteger<int64>required
Description
Message template ID
Format
int64

Header Parameters

acceptstring
Description
Generated from available response content types
Default
application/json
Allowed
application/jsonapplication/vnd.optivo.broadmail.v1+json

Form Parameters

subjectForTargetGroupstring
Description
Subject specific to the target group. Set 'subject.[targetGroupId]' in request data (only email).Does not work with the "Try it out" feature.
cmsContentTemplateIdstring
Description
ID of source content template
messageTemplateIdForCreateinteger<int64>
Description
ID of source message template for creation
Format
int64
messageTemplateIdForCopyinteger<int64>
Description
ID of source message template for copying
Format
int64
replyToAddressstring
Description
Reply-to address (only email)
mailingIdinteger<int64>
Description
ID of source mailing
Format
int64
resetReplyToAddressboolean
Description
Reset the local part of the reply-to address
resetTargetedSubjectsboolean
Description
If true, all target groups subjects are deleted (only email)
replyToNamestring
Description
Reply-to mailing name (only email)
namestringrequired
Description
Name of the message template
senderNamestring
Description
Mailing sender name (only email)
subjectstring
Description
Mailing subject (only email)
senderAddressstring
Description
Mailing sender address

Responses

200The message template was updated successfully.

RestMessageTemplate
- idinteger<int64>
  Description
  Message template ID
  Format
  int64
- namestring
  Description
  Message template name
- contentIdstring
  Description
  Content ID of the message template
- contentTemplatestring
  Description
  Content template
- mediaTypestring
  Description
  Media type of the message template
- senderAddressstring
  Description
  Email address of the sender
- senderNamestring
  Example
  Episerver GmbH
  Description
  Sender name
- replyToAddressstring
  Description
  Email address for reply mails
- replyToNamestring
  Description
  Name for reply mails
- subjectmap<string, string>
  Description
  Subjects
- formatstring
  Description
  Format
- dispatchOptionstring
  Description
  Dispatch option of the message template
- dispatchStrategyOptionstring
  Description
  Dispatch strategy option of the message template
- accumulateMessagesForDaysinteger<int32>
  Description
  Number of messages per day
  Format
  int32
- createdstring<date-time>
  Description
  Creation date
  Format
  date-time
- modifiedstring<date-time>
  Description
  Modification date
  Format
  date-time
- linksobject[]
  Description
  Restful links
  - uriBuilderobject
  - relsstring[]
  - relstring
  - typestring
  - paramsmap<string, string>
  - titlestring
  - uristring<uri>
    Format
    uri

curl

curl --request POST \
     --url https://api.campaign.episerver.net/rest/{clientId}/messagetemplates/{messageTemplateId} \
     --header 'accept: application/json' \
     --header 'content-type: application/x-www-form-urlencoded' \
     --data 'name=string'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/x-www-form-urlencoded");

var urlencoded = new URLSearchParams();
urlencoded.append("name", "string");

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: urlencoded,
   redirect: 'follow'
};

fetch("https://api.campaign.episerver.net/rest/{clientId}/messagetemplates/{messageTemplateId}", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "net/http"

url = URI("https://api.campaign.episerver.net/rest/{clientId}/messagetemplates/{messageTemplateId}")

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

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/x-www-form-urlencoded"
request.body = "name=string"

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

python

import requests

url = "https://api.campaign.episerver.net/rest/{clientId}/messagetemplates/{messageTemplateId}"

payload = 'name=string'
headers = {
   'accept': 'application/json',
   'content-type': 'application/x-www-form-urlencoded'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

200

// The message template was updated successfully.
{
  "id": "",
  "name": "",
  "contentId": "",
  "contentTemplate": "",
  "mediaType": "",
  "senderAddress": "",
  "senderName": "Episerver GmbH",
  "replyToAddress": "",
  "replyToName": "",
  "subject": "",
  "format": "",
  "dispatchOption": "",
  "dispatchStrategyOption": "",
  "accumulateMessagesForDays": "",
  "created": "",
  "modified": "",
  "links": [
    {
      "uriBuilder": {},
      "rels": [
        ""
      ],
      "rel": "",
      "type": "",
      "params": "",
      "title": "",
      "uri": ""
    }
  ]
}