tools.ozone.communication.createTemplate
POST/xrpc/tools.ozone.communication.createTemplate
This endpoint is part of the Ozone moderation service APIs. Requests usually require authentication, are directed to the user's PDS intance, and proxied to the Ozone instance indicated by the DID in the service proxying header. Admin authenentication may also be possible, with request sent directly to the Ozone instance.
To learn more about calling atproto API endpoints like this one, see the API Hosts and Auth guide.
Administrative action to create a new, re-usable communication (email for now) template.
Request
- application/json
Body
required
Name of the template.
Content of the template, markdown supported, can contain variable placeholders.
Subject of the message, used in emails.
Message language.
DID of the user who is creating the template.
Responses
- 200
- 400
- 401
OK
- application/json
- Schema
- Example (from schema)
Schema
Name of the template.
Content of the template, can contain markdown and variable placeholders.
Subject of the message, used in emails.
Message language.
DID of the user who last updated the template.
{
"id": "string",
"name": "string",
"subject": "string",
"contentMarkdown": "string",
"disabled": true,
"lang": "string",
"lastUpdatedBy": "string",
"createdAt": "2024-11-07T00:27:32.124Z",
"updatedAt": "2024-11-07T00:27:32.124Z"
}
Bad Request
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [InvalidRequest
, ExpiredToken
, InvalidToken
, DuplicateTemplateName
]
{
"error": "InvalidRequest",
"message": "string"
}
Unauthorized
- application/json
- Schema
- Example (from schema)
Schema
{
"message": "string"
}