---
title: "Edit Email Template Object"
method: PATCH
path: "/v3.0/email-templates/{slug}/"
tags: ["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

- `slug` string, required

## Headers

- `x-api-key` string, required
- `x-workspace` string

## Request body

- PatchedEmailTemplateRequest
  - `email_server_slug` string, nullable: the email server used by this email template for sending emails.
  - `pdf_template` string, nullable: the pdf template used by this email template for generating emails.
  - `slug` string, nullable
  - `title` string, nullable: a title to identify the email template
  - `sender_email` string, nullable: use if you want to send the email from a specific address. can be read from the context.
  - `reply_to_email` string, nullable: the address to set as the email's `reply to` email address.
  - `sender_name` string, nullable: use if you want to set the sender's name. can be read from the context.
  - `subject` string, nullable: use to set a template for emil's subject
  - `body` string: body of the email template
  - `bcc_to` string, nullable: a comma separated list of email addresses. emails sent using this template will be bcc'ed to these addresses as well.
  - `is_enabled` boolean
  - `ai_engine_id` string, nullable
  - `business` integer, nullable: business that owns this email template.

## Response `200`

- EmailTemplate
  - `is_active` string
  - `pdf_template` string, nullable: the pdf template used by this email template for generating emails.
  - `email_server` EmailSenderShort
    - `is_system_default` boolean: is this a default email sender created by system?
    - `slug` string, nullable
    - `title` string, nullable: a title to identify this email sever
  - `is_example` boolean
  - `is_default_example` boolean: if set true, each new email template will use this template's body by default.
  - `created_at` string, date-time
  - `updated_at` string, date-time
  - `slug` string, nullable
  - `title` string, nullable: a title to identify the email template
  - `sender_email` string, nullable: use if you want to send the email from a specific address. can be read from the context.
  - `reply_to_email` string, nullable: the address to set as the email's `reply to` email address.
  - `sender_name` string, nullable: use if you want to set the sender's name. can be read from the context.
  - `subject` string, nullable: use to set a template for emil's subject
  - `body` string: body of the email template
  - `bcc_to` string, nullable: a comma separated list of email addresses. emails sent using this template will be bcc'ed to these addresses as well.
  - `is_enabled` boolean
  - `ai_engine_id` string, nullable
  - `business` integer, nullable: business that owns this email template.

---

[API](https://skmtc.dev/formaloo/apis/formaloo-api-documentation.md) · [All operations](https://skmtc.dev/formaloo/apis/formaloo-api-documentation/llms.txt) · [OpenAPI document](https://skmtc.dev/formaloo/apis/formaloo-api-documentation/revisions/47b268aeb656?raw)
