Update email template details

PATCH /api/email-templates/{id}/details
O auth2

Update the details of an email template by its ID.

Path parameters

  • id string Required

    The unique identifier of the email template.

application/json

Body Required

  • subject string

    The template of the email subject.

  • content string

    The template of the email body.

  • contentType string("text/html") | string("text/plain")

    The content type of the email body. (Only required by some specific email providers.)

    One of:
    string-1 string("text/html") string-2 string("text/plain")
  • replyTo string

    The reply name template of the email. If not provided, the target email address will be used. (The render logic may differ based on the email provider.)

  • sendFrom string

    The send from name template of the email. If not provided, the default Logto email address will be used. (The render logic may differ based on the email provider.)

Responses

  • 200 application/json

    The updated email template.

    Hide response attributes Show response attributes object
    • tenantId string Required

      Maximum length is 21.

    • id string Required

      Minimum length is 1, maximum length is 21.

    • languageTag string Required

      Minimum length is 1, maximum length is 16.

    • templateType string Required

      Values are SignIn, Register, ForgotPassword, OrganizationInvitation, Generic, UserPermissionValidation, or BindNewIdentifier.

    • details object Required
      Hide details attributes Show details attributes object
    • createdAt number Required
  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    The email template was not found.

PATCH /api/email-templates/{id}/details 
curl \
 --request PATCH 'https://[tenant_id].logto.app/api/email-templates/{id}/details' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"subject":"string","content":"string","contentType":"string","replyTo":"string","sendFrom":"string"}'
Request examples 
{
  "subject": "string",
  "content": "string",
  "contentType": "string",
  "replyTo": "string",
  "sendFrom": "string"
}
Response examples (200) 
{
  "tenantId": "string",
  "id": "string",
  "languageTag": "string",
  "templateType": "SignIn",
  "details": {
    "subject": "string",
    "content": "string",
    "contentType": "string",
    "replyTo": "string",
    "sendFrom": "string"
  },
  "createdAt": 42.0
}