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}
JWTautomatedEmail:write

Path parameters

idstringrequired

Unique identifier for the automated email.

Request body

namestring

Name of the email template. Letters (a-z, A-Z), numbers, underscores and hyphens.

Length: [3,256]Pattern: ^[a-zA-Z0-9_-]+$

fromNamestring

Name of the email sender.

Length: [1,256]

fromEmailstring

From email address.

Length: [0,256]Format: email

ccstring

Cc address for the email template.

Length: [0,256]

bccstring

Bcc address for the email template.

Length: [0,256]

replyTostring

Reply-To address for the email template.

Length: [0,256]

enabledboolean

Enable or disable the email template.

subjectstring

Subject of the email template.

Length: [1,256]

bodystring

Body of the email template.

Length: [3,20000]

eventstring

Event to trigger sending of the email.

Length: [1,256]

customboolean

Use custom email template.

productIdsarray of string

Optional list of product IDs that this email template should apply to for license events.

Response

200 OK

idstringrequired
createdAtstringrequired

Format: date-time

updatedAtstringrequired

Format: date-time

namestringrequired
fromNamestringrequired
fromEmailstringrequired
ccstringrequired
bccstringrequired
subjectstringrequired
bodystringrequired
replyTostringrequired
eventstringrequired
enabledbooleanrequired
custombooleanrequired
sentintegerrequired

Format: int64

productIdsarray of stringrequired