Skip to main content
Version: v3New

Update an email template

PATCH 

/emails/locations/:locationId/templates/:templateId

Update email template

Request

Version stringrequired

API Version

Available optionsv3
locationId stringrequired

Location ID

templateId stringrequired

Template ID

application/json

Bodyrequired

    namestring

    Template name

    editorContentstring

    Editor content to update. Required only when updating template content, and must be provided together with editorType. Provide HTML or plain-text string content.

    editorTypestring

    Type of editor content. Required only when updating template content, and must be provided together with editorContent.

    Available optionshtmltext
    previewTextstring

    Preview text

    subjectLinestring

    Email subject line

    fromNamestring

    Sender name

    fromEmailstring

    Sender email address

    archivedboolean

    Whether template is archived

    parentFolderIdstring

    Parent folder ID. Pass null to move template to the root level.

    userIdstring

    ID of the user performing this action

application/json

Success

Schema
    idstringrequired

    Template ID

    namestringrequired

    Template name

    archivedbooleanrequired

    Whether template is archived

    fromNamestringrequired

    Sender name

    fromEmailstringrequired

    Sender email address

    subjectLinestringrequired

    Email subject line

    previewTextstringrequired

    Preview text

    previewUrlstringrequired

    Preview URL

    editorTypestring

    Template type

    Available optionshtmltext
    isPlainTextboolean

    Whether template is plain text

    parentFolderIdstring

    Parent folder ID

    updatedAtstring

    Last updated timestamp

    createdAtstring

    Created timestamp

    traceIdstring

    Trace ID of request