
| Parameter name | Value | Description |
|---|---|---|
action |
string |
Type of action. Values: "signupRight", "newRight", "formFilledAccount", "formFilledClient", "report", "linkSharing". |
name |
string |
Name of the message template. |
languages |
object |
Languages of the message template. Values: "en", "fr", "de", "es", "pt", "it". |
languages[language].id |
string |
Identifier of message template. |
languages[language].language |
string |
Language of message template. |
languages[language].subject |
string |
Subject of the message template. |
languages[language].html |
string |
HTML body of the message template. |
default |
boolean |
If the content of the message template is a default message template. Read-only |
Authentication is required to execute this request. Please refer to Authentication for more.
{action}| Parameter name | Value | Description |
|---|---|---|
| Path parameters | ||
action |
string |
Action of the message template. |
Do not supply a request body with this method.
If successful, this method returns an empty response body.
Authentication is required to execute this request. Please refer to Authentication for more.
{action}| Parameter name | Value | Description |
|---|---|---|
| Path parameters | ||
action |
string |
Action of the message template. |
| Optional query parameters | ||
language |
string |
language for template details. Default value: "en". |
Do not supply a request body with this method.
If successful, this method returns a Message Template in the response body.
Authentication is required to execute this request. Please refer to Authentication for more.
| Parameter name | Value | Description |
|---|---|---|
| Optional query parameters | ||
withContent |
boolean |
Retrieves message templates content for each language. |
language |
string |
language for template details. Default value: "en". |
Do not supply a request body with this method.
If successful, this method returns a response body with the following structure:
Authentication is required to execute this request. Please refer to Authentication for more.
{action}| Parameter name | Value | Description |
|---|---|---|
| Path parameters | ||
action |
string |
Action of the message template. |
| Optional query parameters | ||
language |
string |
language for template details. Default value: "en". |
In the request body, supply a Message Template Resource with the following properties:
| Parameter name | Value | Description |
|---|---|---|
| Optional Properties | ||
name |
string |
Name of the message template. |
languages |
object |
Languages of the message template. Values: "en", "fr", "de", "es", "pt", "it". |
languages[language].id |
string |
Identifier of message template. |
languages[language].language |
string |
Language of message template. |
languages[language].subject |
string |
Subject of the message template. |
languages[language].html |
string |
HTML body of the message template. |
If successful, this method returns a Message Template Resource in the response body.