Sign in
Email Template

Update email template

Update email template object.

put/api/v1/email_templates/{emailTemplateID}

Path parameters

emailTemplateIDinteger required

A unique integer value identifying this email template.

Request body

idinteger

ID of the email template

urlstring uri

URL of the email template

namestring

Name of the email template

queuestring uri

Queue URL.

organizationstring uri

Organization URL.

triggersstring[]

URLs of the linked triggers

type'rejection' | 'rejection_default' | 'email_with_no_processable_attachments' | 'custom'

Type of the email template. Only templates with types rejection and custom can be manually created and deleted.

  • rejection - Template for a rejection email
  • rejection_default - Default template for a rejection email
  • email_with_no_processable_attachments - Template for a reply to an email with no attachments
  • custom - Custom email template
subjectstring

Email subject

messagestring

HTML subset of text email section

enabledboolean

(Deprecated) Use automate instead

automateboolean

True if user wants to send email automatically on the action

modified_bystring uri nullable

User that last modified the object.

modified_atstring date-time nullable

Timestamp of last modification.

Example request

{
  "id": 1234,
  "url": "https://example.rossum.app/api/v1/email_templates/789",
  "name": "My Email Template",
  "queue": "https://example.rossum.app/api/v1/queues/8198",
  "organization": "https://example.rossum.app/api/v1/organizations/406",
  "triggers": [
    "https://example.rossum.app/api/v1/triggers/500",
    "https://example.rossum.app/api/v1/triggers/600"
  ],
  "type": "custom",
  "subject": "My Email Template Subject",
  "message": "<p>My Email Template Message</p>",
  "enabled": true,
  "automate": true,
  "to": [
    {
      "email": "recipient@example.com",
      "name": "Recipient Name"
    }
  ],
  "cc": [],
  "bcc": [],
  "modified_by": "https://example.rossum.app/api/v1/users/10775",
  "modified_at": "2021-04-26T10:08:03.856648Z"
}

Response

OK

idinteger required

ID of the email template

urlstring uri required

URL of the email template

namestring required

Name of the email template

queuestring uri required

Queue URL.

organizationstring uri required

Organization URL.

triggersstring[] required

URLs of the linked triggers

type'rejection' | 'rejection_default' | 'email_with_no_processable_attachments' | 'custom' required

Type of the email template. Only templates with types rejection and custom can be manually created and deleted.

  • rejection - Template for a rejection email
  • rejection_default - Default template for a rejection email
  • email_with_no_processable_attachments - Template for a reply to an email with no attachments
  • custom - Custom email template
subjectstring required

Email subject

messagestring required

HTML subset of text email section

enabledboolean required

(Deprecated) Use automate instead

automateboolean required

True if user wants to send email automatically on the action

modified_bystring uri nullable required

User that last modified the object.

modified_atstring date-time nullable required

Timestamp of last modification.

Example response

{
  "id": 1234,
  "url": "https://example.rossum.app/api/v1/email_templates/789",
  "name": "My Email Template",
  "queue": "https://example.rossum.app/api/v1/queues/8198",
  "organization": "https://example.rossum.app/api/v1/organizations/406",
  "triggers": [
    "https://example.rossum.app/api/v1/triggers/500",
    "https://example.rossum.app/api/v1/triggers/600"
  ],
  "type": "custom",
  "subject": "My Email Template Subject",
  "message": "<p>My Email Template Message</p>",
  "enabled": true,
  "automate": true,
  "to": [
    {
      "email": "recipient@example.com",
      "name": "Recipient Name"
    }
  ],
  "cc": [],
  "bcc": [],
  "modified_by": "https://example.rossum.app/api/v1/users/10775",
  "modified_at": "2021-04-26T10:08:03.856648Z"
}

Changes

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