tools.ozone.communication.updateTemplate

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

Details · procedure
Kindprocedure
Authoritycommunication.ozone.tools
Indexed
cid bafyreifaptsxxt3tgcrcmmioizqbdrkrzdpn5uge6ktxdt2kw6rvesgv44

Checks

Valid
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Administrative action to update an existing communication template. Allows passing partial fields to patch specific fields only.",
      "errors": [
        {
          "name": "DuplicateTemplateName"
        }
      ],
      "input": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "contentMarkdown": {
              "description": "Content of the template, markdown supported, can contain variable placeholders.",
              "type": "string"
            },
            "disabled": {
              "type": "boolean"
            },
            "id": {
              "description": "ID of the template to be updated.",
              "type": "string"
            },
            "lang": {
              "description": "Message language.",
              "format": "language",
              "type": "string"
            },
            "name": {
              "description": "Name of the template.",
              "type": "string"
            },
            "subject": {
              "description": "Subject of the message, used in emails.",
              "type": "string"
            },
            "updatedBy": {
              "description": "DID of the user who is updating the template.",
              "format": "did",
              "type": "string"
            }
          },
          "required": [
            "id"
          ],
          "type": "object"
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "ref": "tools.ozone.communication.defs#templateView",
          "type": "ref"
        }
      },
      "type": "procedure"
    }
  },
  "id": "tools.ozone.communication.updateTemplate",
  "lexicon": 1
}