tools.ozone.communication.createTemplate

POST 
tools.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

OK

application/json

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

Example (from schema)

{
  "id": "string",
  "name": "string",
  "subject": "string",
  "contentMarkdown": "string",
  "disabled": true,
  "lastUpdatedBy": "string",
  "createdAt": "2024-05-19T00:25:07.390Z",
  "updatedAt": "2024-05-19T00:25:07.390Z"
}

400

Bad Request

application/json

Schema

Schema

error stringrequired

Possible values: [InvalidRequest, ExpiredToken, InvalidToken]

message stringrequired

Example (from schema)

{
  "error": "InvalidRequest",
  "message": "string"
}

401

Unauthorized

application/json

Schema

Schema

error required
message stringrequired

Example (from schema)

{
  "message": "string"
}

Loading...