EmailClick

root link

Link

Any of

root link anyOf EmailLink

Type: object
No Additional Properties

root link anyOf EmailLink email

Email

Type: string
Must match regular expression: (^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$)

Example:

"jane@example.com"

root link anyOf EmailSha256Link

Type: object
No Additional Properties

root link anyOf EmailSha256Link email_sha256

Email Sha256

Type: string

Ensure that the email address is lowercase before hashing.

Example:

"8c87b489ce35cf2e2f39f80e282cb2e804932a56a213983eeeb428407d43b52d"

root link anyOf EmailMd5Link

Type: object
No Additional Properties

root link anyOf EmailMd5Link email_md5

Email Md5

Type: string

Ensure that the email address is lowercase before hashing.

Example:

"9e26471d35a78862c17e467d87cddedf"

root link anyOf CustomerIdLink

Type: object
No Additional Properties

root link anyOf CustomerIdLink customer_id

Customer Id

Type: string

A unique identifier for a customer.

Example:

"123456789"

root link anyOf CustomerIdLink system_name

System Name

Type: string

An optional name for the system of origin.

Example:

"SuperPOS 2000"

root link anyOf MobileLink

Type: object
No Additional Properties

root link anyOf MobileLink mobile

Mobile

Type: string

Formatted with the international code with no spaces or symbols.

Example:

"61491570006"

root link anyOf ExternalLink

Type: object
No Additional Properties

root link anyOf ExternalLink external_id

External Id

Type: string

A unique identifier for a customer in an external system.

Example:

"123456789"

root link anyOf ExternalLink system_name

System Name

Type: string

A unique identifer for the external system itself.

Example:

"super_pos_2000"

root link anyOf CustomerLink

Type: object

This type of link is deprecated. Please use one of the other specific link types instead.

No Additional Properties

root link anyOf CustomerLink link_type

Type: enum (of string)

An enumeration.

Must be one of:

"email"
"email_sha256"
"customer_id"
"mobile"
"engage.id"
"external_id"
"email_md5"

root link anyOf CustomerLink link_value

Link Value

Type: string

Must be at least 1 characters long

root link anyOf CustomerLink id_type

Id Type

Type: string Default: "default"

root action_at

Action At

Type: stringFormat: date-time

root email_id

Email Id

Type: string

A unique identifier for an individual email event.

Example:

"send-job-a7e23-jane-doe"

root list

Type: object

root list id

Id

Type: string

Example:

"7bff7a..."

root list name

Name

Type: string

Examples:

"All Customers List"

"Lapsed Customers"

root campaign_id

Campaign Id

Type: string

Campaign Identifier or Name.

Example:

"Black friday Menswear Teaser Aug 2020"

root from

From

Type: object

Sender Details

root from name

Name

Type: string

Example:

"Jane Doe"

root from email

Email

Type: string
Must match regular expression: (^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$)

Example:

"jane@example.com"

root to

To

Type: object

Recipient Details

root from name

Name

Type: string

Example:

"Jane Doe"

root from email

Email

Type: string
Must match regular expression: (^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$)

Example:

"jane@example.com"

root clicked_link

Type: object

root clicked_link name

Name

Type: string

The plain text name of the link.

root clicked_link url

Url

Type: string

The URL link.

EmailClick

link Required

Link

Any of

email Required

Email

email_sha256 Required

Email Sha256

email_md5 Required

Email Md5

customer_id Required

Customer Id

system_name

System Name

mobile Required

Mobile

external_id Required

External Id

system_name Required

System Name

link_type Required

Must be one of:

link_value Required

Link Value

id_type

Id Type

action_at Required

Action At

email_id Required

Email Id

list

id Required

Id

name Required

Name

campaign_id

Campaign Id

from

From

name

Name

email Required

Email

to

To

name

Name

email Required

Email

clicked_link

name

Name

url

Url