Outreach Jobs (Full Update)
Description
Enqueues Templated Email Job Resources to be run by the message dispatcher. Supports bulk operations.
See the Aerial Spec for more details.
File Naming Convention
TGEN_outreachTemplatedEmail_fullupdate_2026-08_<optionalSuffix>.csv
importType:fullupdateapiVersion:2026-08
Columns
Nested object fields are flattened into columns using dot notation (parent.child). Array fields are flattened using zero-based index notation, one element per column (field[0], field[1], and so on).
Note: A whole array cannot be passed in a single column: a literal value such as ['value-1','value-2'] will be rejected. To import multiple array elements, add one indexed column per element. Rows in the table below with type array describe the field as a whole and are not valid CSV column headers.
| Column Header | Description | Key Information | Type | Required |
|---|---|---|---|---|
template | Uuid or External ID of the email template. Mutually exclusive with body; one of template or body must be provided. | string | No | |
body | Raw email body for template-less sends. Mutually exclusive with template; one of template or body must be provided. May include {{<type> index=“N”}} attachment placeholders. | string | No | |
subject | Subject line for the email. Used as an override when template is provided, or as the subject for raw-body sends. | string | No | |
attachments | Composer attachments (products, looks, photos, videos, media-library items) to include in the message. Honoured for both templated and raw-body modes. | Not a CSV column header. Pass each array element in its own indexed column (attachments[0], attachments[1], and so on). | array | No |
attachments[0] | Array element | mixed | No | |
attachments[0].type | Type of attachment. Product, Look, Microsite (an unlimited look filling {{microsite_url}}) and Wishlist reference UUIDs; Photo, Video, and Media may reference a UUID (library item) or a URL (uploaded asset). | mixed | No | |
attachments[0].value | Attachment reference. Un-expanded: a UUID for Product/Look/Microsite/Wishlist, or a UUID/URL for Photo/Video/Media. When the field is expanded, the UUID is replaced with the referenced resource: a Product for Product, a Look for Look and Microsite, a WishList for Wishlist, a ShareableMediaFile for Photo/Video/Media. URL-form values for Photo/Video/Media are returned as-is. | mixed | No | |
attachments[0].position | Stable render order within attachments of the same type. | integer | No | |
employee | Uuid or External ID of the employee. Used if the template has replacement terms associated with the employee. | string | No | |
customer | Uuid or External ID of the customer. Used if the template has replacement terms associated with the customer. | string | No | |
store | Uuid or External ID of the store. Used if the template has replacement terms associated with the store. | string | No | |
to | Email address of the recipient of the email | string | No | |
from | Email address of the sender of the email | string | No | |
fromName | Name of the sender of the message | string | No | |
campaign | Uuid or External ID of the campaign this job is associated with | string | No | |
inReplyTo | Uuid or Message-ID of the stored inbound email this message replies to. The created job inherits the conversation thread and carries the reply headers. | string | No | |
expiryDate | Datetime of when the email should no longer be sent out in Z-normalized RFC3339 format | string | No | |
startDate | Datetime of when the message should be sent out in Z-normalized RFC3339 format | string | No |
Sample CSV
See the following outreachTemplatedEmail CSV sample file.
outreachTemplatedEmail Sample 1
Note: The sample CSV may contain sample ID fields which reference other resources that do not match the data in your environment.