tools.ozone.communication.updateTemplate
POSTtools.ozone.communication.updateTemplate
Administrative action to update an existing communication template. Allows passing partial fields to patch specific fields only.
Request
- application/json
Body
required
id stringrequired
ID of the template to be updated.
name string
Name of the template.
contentMarkdown string
Content of the template, markdown supported, can contain variable placeholders.
subject string
Subject of the message, used in emails.
updatedBy did
DID of the user who is updating the template.
disabled boolean
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-19T00:25:07.393Z",
"updatedAt": "2024-05-19T00:25:07.393Z"
}
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...