All guides
User

Email Automation

Run a defined action when its configured trigger and conditions match.

Step-by-step guide

Before you start

Use the account and workspace that own the records. This page does not include administrator configuration forms.

Open this feature

Open /portal/email-automation/automations on your application domain, or use the matching item in the application menu.

Steps

Save automation

  1. Open /portal/email-automation/automations on your own application domain.
  2. Complete these fields in that form: Business, Name, Trigger, Status, Timing, Unit, Email template, Recipient, Custom email, Field, Operator, Value. Their choices and limits are listed below.
  3. Select Save automation. The exact label can change between creating and editing a record.
  4. If validation fails, correct the named field and submit again. After success, reopen the same record and compare the saved values.
Field shown in the formWhat to enterExample / note
BusinessOptional, unless this form asks for it. Choose All businesses. Enter a whole number.Use the value appropriate to your test account; no preset is supplied.
NameRequired. No more than 255 characters.Test record (use a unique value where required).
TriggerRequired. Choose one of the options shown by the form.Use the value required by the task; no example is assumed.
StatusRequired. Choose Draft, Active, Inactive.Choose a displayed option; the available labels are listed above.
TimingRequired. Choose Immediately, After delay.Choose a displayed option; the available labels are listed above.
UnitRequired. Choose Minutes, Hours, Days.Choose a displayed option; the available labels are listed above.
Email templateRequired. Enter a whole number.Use the value required by the task; no example is assumed.
RecipientRequired. Choose Customer, Business owner, Custom email.Choose a displayed option; the available labels are listed above.
Custom emailOptional, unless this form asks for it. Use an email address you control for a test. No more than 255 characters.Use your controlled test inbox.
FieldOptional, unless this form asks for it. No more than 80 characters.Use the value required by the task; no example is assumed.
OperatorRequired. Choose one of the options shown by the form.Use the value required by the task; no example is assumed.
ValueOptional, unless this form asks for it. Choose No value needed. No more than 255 characters.Choose a displayed option; the available labels are listed above.

Save template

  1. Open /portal/email-automation/templates on your own application domain.
  2. Complete these fields in that form: Business, Name, Type, Subject, Preheader, Body, Language, Status. Their choices and limits are listed below.
  3. Select Save template. The exact label can change between creating and editing a record.
  4. If validation fails, correct the named field and submit again. After success, reopen the same record and compare the saved values.
Field shown in the formWhat to enterExample / note
BusinessOptional, unless this form asks for it. Choose All businesses. Enter a whole number.Use the value appropriate to your test account; no preset is supplied.
NameRequired. No more than 255 characters.Test record (use a unique value where required).
TypeRequired. No more than 80 characters.Use the value required by the task; no example is assumed.
SubjectRequired. No more than 255 characters.Use the value required by the task; no example is assumed.
PreheaderOptional, unless this form asks for it. No more than 255 characters.Use the value required by the task; no example is assumed.
BodyRequired. No more than 10000 characters.Use the value required by the task; no example is assumed.
LanguageRequired. No more than 12 characters.Use the value required by the task; no example is assumed.
StatusRequired. Choose Active, Inactive.Choose a displayed option; the available labels are listed above.

Fields shown in the interface

Only fields traced to this role’s handler and its own view are listed. The application can show separate create/edit forms; do not fill every row on one screen.

Form 1 — fields shown in the interface
FieldWhat to enter or choose
BusinessOptional, unless this form asks for it. Choose All businesses. Enter a whole number.
NameRequired. No more than 255 characters.
TriggerRequired. Choose one of the options shown by the form.
StatusRequired. Choose Draft, Active, Inactive.
TimingRequired. Choose Immediately, After delay.
UnitRequired. Choose Minutes, Hours, Days.
Email templateRequired. Enter a whole number.
RecipientRequired. Choose Customer, Business owner, Custom email.
Custom emailOptional, unless this form asks for it. Use an email address you control for a test. No more than 255 characters.
FieldOptional, unless this form asks for it. No more than 80 characters.
OperatorRequired. Choose one of the options shown by the form.
ValueOptional, unless this form asks for it. Choose No value needed. No more than 255 characters.
Form 2 — fields shown in the interface
FieldWhat to enter or choose
BusinessOptional, unless this form asks for it. Choose All businesses. Enter a whole number.
NameRequired. No more than 255 characters.
TypeRequired. No more than 80 characters.
SubjectRequired. No more than 255 characters.
PreheaderOptional, unless this form asks for it. No more than 255 characters.
BodyRequired. No more than 10000 characters.
LanguageRequired. No more than 12 characters.
StatusRequired. Choose Active, Inactive.

Check the result

After a source-checked procedure, verify the same record in the same workspace. Check saved values, visible state and access with the intended test account. An external payment/message/provider action needs its own result check.

Problems and validation

ProblemNext step
A field rejects the valueCheck its named error, the form’s visible choices and the relevant limit. Do not substitute internal numeric codes for the displayed options.
The control is missingCheck role, plan, enabled app and current record state. Do not grant administrator access merely to complete a User task.
The saved result is unexpectedReopen the same record and verify its owner/workspace before repeating the action.

Messages defined for this screen

MessageWhat to review
Your current plan allows up to :limit email automations.Check the related field or action in this role’s form.
Your current plan allows up to :limit email templates.Check the related field or action in this role’s form.

Technical reference

Role-scoped source references

Pinned commit: 5af0236c6d99c50079f5ab8b8fb035506634bd8d

Source-only route information
MethodSource-default route
GET/portal/email-automation/automations
GET/portal/email-automation/templates
GET/portal/email-automation/logs