Email

Update an email template

Changes only the fields you send. Emails that are scheduled with this template use the new version when they go out.

patch/email-templates/{id}

Request

  • Base URL: https://api.hypamoon.com/api/v1
  • URL: https://api.hypamoon.com/api/v1/email-templates/{id}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.hypamoon.com/oauth/authorize, token URL https://api.hypamoon.com/oauth/token, scopes: messages:write)

Path parameters

idstring uuid required

The id of the template.

Request body

namestring
subjectstring
htmlstring nullable
textstring nullable
style'site' | 'none'
site_idstring uuid nullable

Response

The updated template.

idstring uuid required
namestring required
subjectstring required
htmlstring nullable required
textstring nullable required
style'site' | 'none' required

site: the name, logo and colors of the project's site around the email. none: sent as it is.

site_idstring uuid nullable required
variablesstring[] required

The variables in the subject and content, like name or order_number.

created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.