tools.ozone.communication.listTemplates

GET 
tools.ozone.communication.listTemplates

Get list of all communication templates.

Request

Responses

200

OK

application/json

Schema

Schema

communicationTemplates

object[]

required

Array [

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)

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

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