Skip to main content

tools.ozone.communication.updateTemplate

POST 
/xrpc/tools.ozone.communication.updateTemplate

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 update an existing communication template. Allows passing partial fields to patch specific fields only.

Request​

Body

required

    id stringrequired

    ID of the template to be updated.

    name string

    Name of the template.

    lang language

    Message language.

    contentMarkdown string

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

    subject string

    Subject of the message, used in emails.

    updatedBy did

    DID of the user who is updating the template.

    disabled boolean

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
Loading...