Sign in
Auth Configuration

Create email template

Changed on

Creates a custom email template for the project. Custom email templates are a SUPERAGENT feature: requests from a HOBBY project owner are rejected with 403, and HOBBY projects always send the built-in default templates regardless of any previously saved custom rows. Every project is created with one template per type, so customizing one is usually a PUT; creating a type the project already has returns 409. Valid template types: welcome, confirmation, password_reset, password_changed

post/projects/{id}/email-templates

Request

  • Base URL: https://api.volcano.dev
  • URL: https://api.volcano.dev/projects/{id}/email-templates
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

idstring uuid required

Project ID

Request body

template_type'welcome' | 'confirmation' | 'password_reset' | 'password_changed' required

Type of email template

subjectstring required

Email subject line

html_bodystring required

HTML template body. Available placeholders:

  • {{.Token}} - The confirmation/reset token
  • {{.ProjectName}} - The project name
  • {{.Email}} - User's email address
text_bodystring required

Plain text template body (same placeholders as HTML)

Example request

{
  "subject": "Confirm your email"
}

Response

Template created

idstring uuid
project_idstring uuid
template_type'welcome' | 'confirmation' | 'password_reset' | 'password_changed' required
subjectstring required
html_bodystring required

HTML template with placeholders

text_bodystring required

Plain text template with placeholders

created_atstring date-time
updated_atstring date-time

Example response

{
  "subject": "Confirm your email address"
}

Changes

  • 23e7875e7c4cRevision changes
    • ○

      the endpoint scheme security ProjectAccessToken was added to the API

  • 3a6f365f3f35Revision changes
    • ▲

      added the new path request parameter id

    • ▲

      added the new required request property

    • ▲

      added the new required request property

    • ▲

      added the new required request property

    • ▲

      added the new required request property

    • ▲

      the request's body type changed from no type to object

    • ▲

      the response's body type changed from no type to object for status

    • ▲

      the response's body type changed from no type to object for status

    • ▲

      the response's body type changed from no type to object for status

    • ▲

      the response's body type changed from no type to object for status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status