Skip to main content

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​

Bodyrequired

    name stringrequired

    Name of the template.

    contentMarkdown stringrequired

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

    subject stringrequired

    Subject of the message, used in emails.

    lang language

    Message language.

    createdBy did

    DID of the user who is creating the template.

Responses​

OK
Schema
    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
    lang language

    Message language.

    lastUpdatedBy didrequired

    DID of the user who last updated the template.

    createdAt date-timerequired
    updatedAt date-timerequired

Authorization: http

name: Bearertype: httpscheme: bearer
Request Collapse all
Auth
Body required
{

  "name": "string",

  "contentMarkdown": "string",

  "subject": "string",

  "lang": "string",

  "createdBy": "string"

}
ResponseClear

Click the Send API Request button above and see the response here!