Email Templates Mutations

CreateEmailTemplate

Create an email template

Parameters

input - EmailTemplateInput
Data of the email template

GraphQL

mutation CreateEmailTemplate($input: EmailTemplateInput!) {
  CreateEmailTemplate(input: $input) {
    id
    label
    document_type
    default
    active
    body
    to
    cc
    bcc
    object
    created_at
    updated_at
  }
}

JSON

{
  "input": {
    "label": "Invoice Payment Reminder",
    "document_type": "invoice",
    "default": false,
    "active": true,
    "body": "Dear {{customer_name}},\n\nThis is a reminder that payment for invoice {{invoice_number}} is overdue.\n\nAmount due: {{total_amount}}\nDue date: {{due_date}}\n\nPlease make payment as soon as possible.\n\nBest regards,\n{{company_name}}",
    "object": "Payment Reminder - Invoice {{invoice_number}}",
    "to": ["{{customer_email}}"],
    "cc": ["[email protected]"]
  }
}

JSON

{
  "data": {
    "CreateEmailTemplate": {
      "id": 100003,
      "label": "Invoice Payment Reminder",
      "document_type": "invoice",
      "default": false,
      "active": true,
      "body": "Dear {{customer_name}},\n\nThis is a reminder that payment for invoice {{invoice_number}} is overdue.\n\nAmount due: {{total_amount}}\nDue date: {{due_date}}\n\nPlease make payment as soon as possible.\n\nBest regards,\n{{company_name}}",
      "object": "Payment Reminder - Invoice {{invoice_number}}",
      "to": ["{{customer_email}}"],
      "cc": ["[email protected]"],
      "bcc": [],
      "created_at": "2025-01-15T10:30:00Z",
      "updated_at": "2025-01-15T10:30:00Z"
    }
  }
}

---

UpdateEmailTemplate

Update an email template

Parameters

id - ID
Id of the email template

input - EmailTemplateInput
Data of the email template

GraphQL

mutation UpdateEmailTemplate($id: ID!, $input: EmailTemplateInput!) {
  UpdateEmailTemplate(id: $id, input: $input) {
    id
    label
    document_type
    default
    active
    body
    object
    to
    cc
    bcc
    updated_at
  }
}

JSON

{
  "id": 100003,
  "input": {
    "label": "Urgent Payment Reminder",
    "body": "URGENT: Payment for invoice {{invoice_number}} is now {{days_overdue}} days overdue.\n\nAmount due: {{total_amount}}\nDue date: {{due_date}}\n\nPlease make payment immediately to avoid further action.\n\nBest regards,\n{{company_name}}",
    "object": "URGENT: Payment Reminder - Invoice {{invoice_number}}"
  }
}

JSON

{
  "data": {
    "UpdateEmailTemplate": {
      "id": 100003,
      "label": "Urgent Payment Reminder",
      "document_type": "invoice",
      "default": false,
      "active": true,
      "body": "URGENT: Payment for invoice {{invoice_number}} is now {{days_overdue}} days overdue.\n\nAmount due: {{total_amount}}\nDue date: {{due_date}}\n\nPlease make payment immediately to avoid further action.\n\nBest regards,\n{{company_name}}",
      "object": "URGENT: Payment Reminder - Invoice {{invoice_number}}",
      "to": ["{{customer_email}}"],
      "cc": ["[email protected]"],
      "bcc": [],
      "updated_at": "2025-01-15T11:00:00Z"
    }
  }
}

---

DisableEmailTemplate

Disable an email template

Parameters

id - ID
Id of the email template

GraphQL

mutation DisableEmailTemplate($id: ID!) {
  DisableEmailTemplate(id: $id) {
    id
    label
    active
    updated_at
  }
}

JSON

{
  "id": 100003
}

JSON

{
  "data": {
    "DisableEmailTemplate": {
      "id": 100003,
      "label": "Urgent Payment Reminder",
      "active": false,
      "updated_at": "2025-01-15T12:00:00Z"
    }
  }
}

---

EnableEmailTemplate

Enable an email template

Parameters

id - ID
Id of the email template

GraphQL

mutation EnableEmailTemplate($id: ID!) {
  EnableEmailTemplate(id: $id) {
    id
    label
    active
    updated_at
  }
}

JSON

{
  "id": 100003
}

JSON

{
  "data": {
    "EnableEmailTemplate": {
      "id": 100003,
      "label": "Urgent Payment Reminder",
      "active": true,
      "updated_at": "2025-01-15T13:00:00Z"
    }
  }
}

---

DeleteEmailTemplate

Delete an email template

Parameters

id - ID
Id of the email template

GraphQL

mutation DeleteEmailTemplate($id: ID!) {
  DeleteEmailTemplate(id: $id)
}

JSON

{
  "id": 100003
}

JSON

{
  "data": { "DeleteEmailTemplate": true }
}

---

GenerateEmailTemplate

Generate an email template for a specific document

Parameters

id - ID
Id of the email template

documentId - ID
Id of the document to generate email for

GraphQL

mutation GenerateEmailTemplate($id: ID!, $documentId: ID!) {
  GenerateEmailTemplate(id: $id, documentId: $documentId) {
    id
    label
    body
    object
    to
    cc
    bcc
  }
}

JSON

{
  "id": 100003,
  "documentId": 200045
}

JSON

{
  "data": {
    "GenerateEmailTemplate": {
      "id": 100003,
      "label": "Urgent Payment Reminder",
      "body": "URGENT: Payment for invoice INV-2025-001 is now 15 days overdue.\n\nAmount due: €1,250.00\nDue date: 2025-01-01\n\nPlease make payment immediately to avoid further action.\n\nBest regards,\nAcme Corp",
      "object": "URGENT: Payment Reminder - Invoice INV-2025-001",
      "to": ["[email protected]"],
      "cc": ["[email protected]"],
      "bcc": []
    }
  }
}

---

GetEmailTemplateVariables

Get available variables for a document type

Parameters

document_type - Type
Document type to get variables for

GraphQL

mutation GetEmailTemplateVariables($document_type: Type!) {
  GetEmailTemplateVariables(document_type: $document_type)
}

JSON

{
  "document_type": "invoice"
}

JSON

{
  "data": {
    "GetEmailTemplateVariables": [
      "{{customer_name}}",
      "{{customer_email}}",
      "{{invoice_number}}",
      "{{invoice_date}}",
      "{{due_date}}",
      "{{total_amount}}",
      "{{company_name}}",
      "{{company_email}}"
    ]
  }
}

---

UploadEmailTemplateFile

Upload a file for an email template

Parameters

file - TmpBucketFileInput
File to upload

type - EmailTemplateFileType
Type of file (emailTemplateFiles)

GraphQL

mutation UploadEmailTemplateFile($file: TmpBucketFileInput!, $type: EmailTemplateFileType!) {
  UploadEmailTemplateFile(file: $file, type: $type) {
    id
    filename
    url
  }
}

JSON

{
  "file": {
    "filename": "attachment.pdf",
    "content": "base64_encoded_content"
  },
  "type": "emailTemplateFiles"
}

JSON

{
  "data": {
    "UploadEmailTemplateFile": {
      "id": 5001,
      "filename": "attachment.pdf",
      "url": "https://cdn.example.com/files/attachment.pdf"
    }
  }
}

---

EmailTemplateInput data type

label - String
Label of the email template

document_type - Type
Type of document (invoice, estimate, order, etc.)

default - Boolean
Whether this is the default template for the document type

active - Boolean
Whether the email template is active

body - String
Email body content

object - String
Email subject line

to - [String]
Default TO recipients

cc - [String]
Default CC recipients

bcc - [String]
Default BCC recipients

files - [FileInput]
Attached files

---

Enums

Type (EmailTemplate)

Value	Description
invoice	Invoice document.
estimate	Estimate/quote document.
order	Sales order document.
shipping_order	Shipping order document.
credit_note	Credit note document.
purchase	Purchase order document.
purchase_receipt	Purchase receipt document.
product_return	Product return document.
delivery	Delivery document.
refund	Refund document.
stock_adjustment	Stock adjustment document.
stock_entry	Stock entry document.
stock_removal	Stock removal document.
stock_transfer	Stock transfer document.
subscription	Subscription document.
b2b_store	B2B store document.

EmailTemplateFileType

Value	Description
emailTemplateFiles	Files attached to the email template.