Update an automated email

Updates the specified automated email by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

PATCH/v3/automated-emails/{id}

JWT

automatedEmail:write

Parameters

Name	Type	In	Description
id*	string	path	Unique identifier for the automated email.

Request Body Schema

Property	Type	Description	Constraints
name	string	Name of the email template.	min: 3, max: 256, pattern: ^[a-zA-Z0-9_-]+$
fromName	string	Name of the email sender.	min: 1, max: 256
fromEmail	string	From email address.	min: 0, max: 256, format: email
cc	string	Cc address for the email template.	min: 0, max: 256
bcc	string	Bcc address for the email template.	min: 0, max: 256
replyTo	string	Reply-To address for the email template.	min: 0, max: 256
enabled	boolean	Enable or disable the email template.
subject	string	Subject of the email template.	min: 1, max: 256
body	string	Body of the email template.	min: 3, max: 20000
event	string	Event to trigger sending of the email.	min: 1, max: 256
custom	boolean	Use custom email template.
productIds	array	Optional list of product IDs that this email template should apply to for license events.	items: string

Request Example

{
  "name": "a",
  "fromName": "string",
  "fromEmail": "user@example.com",
  "cc": "string",
  "bcc": "string",
  "replyTo": "string",
  "enabled": true,
  "subject": "string",
  "body": "string",
  "event": "string",
  "custom": true,
  "productIds": [
    "string"
  ]
}

Triggers webhook: automatedEmail.updated

POST <your-webhook-url>
{
  "event": "automatedEmail.updated",
  "data": {
    "id": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "name": "string",
    "fromName": "string",
    "fromEmail": "string",
    "cc": "string",
    "bcc": "string",
    "subject": "string",
    "body": "string",
    "replyTo": "string",
    "event": "string",
    "enabled": true,
    "custom": true,
    "sent": 0,
    "productIds": [
      "string"
    ]
  },
  "triggeredAt": "string"
}

Responses

200

400

401

403

404

429

500

200 OK

{
  "id": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "name": "string",
  "fromName": "string",
  "fromEmail": "string",
  "cc": "string",
  "bcc": "string",
  "subject": "string",
  "body": "string",
  "replyTo": "string",
  "event": "string",
  "enabled": true,
  "custom": true,
  "sent": 0,
  "productIds": [
    "string"
  ]
}