tools.ozone.communication.createTemplate
POSTtools.ozone.communication.createTemplate
Administrative action to create a new, re-usable communication (email for now) template.
Request
- application/json
Body
required
name stringrequired
Name of the template.
contentMarkdown stringrequired
Content of the template, markdown supported, can contain variable placeholders.
subject stringrequired
Subject of the message, used in emails.
createdBy did
DID of the user who is creating the template.
Responses
- 200
- 400
- 401
OK
- application/json
- Schema
- Example (from schema)
Schema
id stringrequired
name stringrequired
Name of the template.
subject string
Content of the template, can contain markdown and variable placeholders.
contentMarkdown stringrequired
Subject of the message, used in emails.
disabled booleanrequired
lastUpdatedBy didrequired
DID of the user who last updated the template.
createdAt date-timerequired
updatedAt date-timerequired
{
"id": "string",
"name": "string",
"subject": "string",
"contentMarkdown": "string",
"disabled": true,
"lastUpdatedBy": "string",
"createdAt": "2024-05-20T00:23:48.213Z",
"updatedAt": "2024-05-20T00:23:48.213Z"
}
Bad Request
- application/json
- Schema
- Example (from schema)
Schema
error stringrequired
Possible values: [InvalidRequest
, ExpiredToken
, InvalidToken
]
message stringrequired
{
"error": "InvalidRequest",
"message": "string"
}
Unauthorized
- application/json
- Schema
- Example (from schema)
Schema
error required
message stringrequired
{
"message": "string"
}
Loading...