tools.ozone.communication.updateTemplate Documentation (EN)

main procedure

Administrative action to update an existing communication template. Allows passing partial fields to patch specific fields only.

Input

Encodingapplication/json

contentMarkdown string Optional

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

disabled boolean Optional

No description available.

id string Required

ID of the template to be updated.

lang stringlanguage Optional

Message language.

name string Optional

Name of the template.

subject string Optional

Subject of the message, used in emails.

updatedBy stringdid Optional

DID of the user who is updating the template.

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": [
        "id"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "ID of the template to be updated."
        },
        "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."
        },
        "disabled": {
          "type": "boolean"
        },
        "updatedBy": {
          "type": "string",
          "format": "did",
          "description": "DID of the user who is updating 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 update an existing communication template. Allows passing partial fields to patch specific fields only."
}