Email

Update an email rule

Partial update; changing position moves the others. Switching a rule off (enabled: false) also cancels its emails that were not sent yet. Below the Growth plan, or while email delivery isn't enabled for the workspace, an update may only switch the rule off.

patch/v1/email-rules/{rule_id}

Request

  • Base URL: https://api-eu.dynamicdocumentapi.com
  • URL: https://api-eu.dynamicdocumentapi.com/v1/email-rules/{rule_id}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

rule_idstring required

Email rule id (emr_…).

Request body

attach_formatsstring[]

Only files of these formats; empty = every file.

attachments'attach_or_link' | 'attach' | 'link' | 'none'
  • attach_or_link - Attach Or Link
  • attach - Attach
  • link - Link
  • none - None
bccstring nullable
ccstring nullable
conditionstring nullable

An expression; the rule sends when it is true. Empty = always.

connection_idstring

emc_… of this workspace.

enabledboolean
from_emailstring nullable

Literal; empty = the connection's default sender. One the provider hasn't verified is saved with the warning email_sender_unverified.

from_namestring nullable

Template source; one line after rendering.

htmlstring nullable

Template source, values HTML-escaped (≤ 256 KiB).

namestring
positioninteger

0 to 4; the others move. Default: the end.

reply_tostring nullable

Template source; one line after rendering.

subjectstring nullable

Template source; required unless a provider template gives it.

textstring nullable

Template source; empty = derived from html.

tostring nullable

Template source rendering to addresses separated by , ; or line breaks.

Response

attach_formatsstring[] required
attachments'attach_or_link' | 'attach' | 'link' | 'none' required
  • attach_or_link - Attach Or Link
  • attach - Attach
  • link - Link
  • none - None
bccstring required
ccstring required
conditionstring required
connection_idstring required
created_atstring date-time required
enabledboolean required
from_emailstring nullable required

null = the connection's default sender.

from_namestring required
htmlstring required
idstring required

emr_…

namestring required
objectstring
positioninteger required

0 to 4: the order the template's rules send in.

reply_tostring required
subjectstring required
template_idstring required
textstring required
tostring required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 2 revisions of this API.