Email

Retrieve an email rule

Common base: API key or OAuth only, never a dashboard region token.

get/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_…).

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.