CRcryptlex
AutomatedEmails

Update an automated email

Changed on

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}

Request

  • Base URL
    https://api.cryptlex.com
  • URL
    https://api.cryptlex.com/v3/automated-emails/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

Unique identifier for the automated email.

Request body

namestring nullable

Name of the email template.

Letters (a-z, A-Z), numbers, underscores and hyphens.

fromNamestring nullable

Name of the email sender.

fromEmailstring email nullable

From email address.

ccstring nullable

Cc address for the email template.

bccstring nullable

Bcc address for the email template.

replyTostring nullable

Reply-To address for the email template.

enabledboolean nullable

Enable or disable the email template.

subjectstring nullable

Subject of the email template.

bodystring nullable

Body of the email template.

eventstring nullable

Event to trigger sending of the email.

customboolean nullable

Use custom email template.

productIdsstring[] nullable

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

Response

OK

idstring required
createdAtstring date-time required
updatedAtstring date-time required
namestring required
fromNamestring required
fromEmailstring required
ccstring required
bccstring required
subjectstring required
bodystring required
replyTostring required
eventstring required
enabledboolean required
customboolean required
sentinteger required
productIdsstring[] required

Changes

  • ec1259c12475Revision changes
    • breaking

      the request property's minLength was increased from 1 to 3

    • breaking

      the request property's minLength was increased from 0 to 3

    • breaking

      the response property's minLength was decreased from 1 to 0 for the response status

    • breaking

      the response property's minLength was decreased from 1 to 0 for the response status

    • breaking

      the response property's minLength was decreased from 1 to 0 for the response status

    • breaking

      the response property's minLength was decreased from 1 to 0 for the response status

    • breaking

      the response property's minLength was decreased from 1 to 0 for the response status

    • breaking

      the response property's minLength was decreased from 1 to 0 for the response status

    • warning

      the request property's maxLength was set to 256

    • warning

      the request property's maxLength was set to 20000

    • warning

      the request property's maxLength was set to 256

    • warning

      the request property's maxLength was set to 256

    • warning

      the request property's maxLength was set to 256

    • info

      added the new optional request property

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property's minLength was decreased from 1 to 0

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      added the required property to the response with the status

  • 68856b660d76Revision changes
    • info

      endpoint added