tools.ozone.communication.createTemplate Documentation (EN)

main procedure

Administrative action to create a new, re-usable communication (email for now) template.

Input

Encodingapplication/json

contentMarkdown string Required

Content of the template, markdown supported, can contain variable placeholders.

createdBy stringdid Optional

DID of the user who is creating the template.

lang stringlanguage Optional

Message language.

name string Required

Name of the template.

subject string Required

Subject of the message, used in emails.

Output

Encodingapplication/json

Schematools.ozone.communication.defs#templateView

Errors

DuplicateTemplateName

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Service Endpoint Base URL for XRPC calls (e.g., https://bsky.social)

Request Body (JSON) Enter valid JSON for the request body

View raw schema

{
  "type": "procedure",
  "input": {
    "schema": {
      "type": "object",
      "required": [
        "subject",
        "contentMarkdown",
        "name"
      ],
      "properties": {
        "lang": {
          "type": "string",
          "format": "language",
          "description": "Message language."
        },
        "name": {
          "type": "string",
          "description": "Name of the template."
        },
        "subject": {
          "type": "string",
          "description": "Subject of the message, used in emails."
        },
        "createdBy": {
          "type": "string",
          "format": "did",
          "description": "DID of the user who is creating the template."
        },
        "contentMarkdown": {
          "type": "string",
          "description": "Content of the template, markdown supported, can contain variable placeholders."
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "DuplicateTemplateName"
    }
  ],
  "output": {
    "schema": {
      "ref": "tools.ozone.communication.defs#templateView",
      "type": "ref"
    },
    "encoding": "application/json"
  },
  "description": "Administrative action to create a new, re-usable communication (email for now) template."
}