email-templates

Edit Email Template Object

patch/v3.0/email-templates/{slug}/

Request

  • Base URL: https://api.formaloo.me
  • URL: https://api.formaloo.me/v3.0/email-templates/{slug}/
  • Auth: none declared. Required headers: x-api-key

Path parameters

slugstring required

Headers

x-api-keystring required

The application secret provided to the client.

x-workspacestring

The value of business_identifier for the current workspace. Not required if your're using the API Key generated for your workspace.

Request body

email_server_slugstring nullable

the email server used by this email template for sending emails.

pdf_templatestring nullable

the pdf template used by this email template for generating emails.

slugstring nullable
titlestring nullable

a title to identify the email template

sender_emailstring nullable

use if you want to send the email from a specific address. can be read from the context.

reply_to_emailstring nullable

the address to set as the email's reply to email address.

sender_namestring nullable

use if you want to set the sender's name. can be read from the context.

subjectstring nullable

use to set a template for emil's subject

bodystring

body of the email template

bcc_tostring nullable

a comma separated list of email addresses. emails sent using this template will be bcc'ed to these addresses as well.

is_enabledboolean
ai_engine_idstring nullable
businessinteger nullable

business that owns this email template.

Response

is_activestring
pdf_templatestring nullable

the pdf template used by this email template for generating emails.

is_exampleboolean
is_default_exampleboolean

if set true, each new email template will use this template's body by default.

created_atstring date-time
updated_atstring date-time
slugstring nullable
titlestring nullable

a title to identify the email template

sender_emailstring nullable

use if you want to send the email from a specific address. can be read from the context.

reply_to_emailstring nullable

the address to set as the email's reply to email address.

sender_namestring nullable

use if you want to set the sender's name. can be read from the context.

subjectstring nullable

use to set a template for emil's subject

bodystring

body of the email template

bcc_tostring nullable

a comma separated list of email addresses. emails sent using this template will be bcc'ed to these addresses as well.

is_enabledboolean
ai_engine_idstring nullable
businessinteger nullable

business that owns this email template.

Changes

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