Emarsys Connector Setup Guide

Configuration

Go to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see About Connectors.

After adding the connector, configure the following settings:

• Username: Username with permissions to access Emarsys APID. For more information about the Emarsys APID username, see Emarsys: Getting started.
• Password: Password for provided username.
• Environment: Environment to make API calls against.

Actions

Action Name	AudienceStream	EventStream
Add Contact to Contact List (Real-Time)	✓	✗
Add Contact to Contact List (Batched)	✓	✗
Create or Update Email Contact (Real-Time)	✓	✗
Create or Update Email Contact (Batched)	✓	✗
Remove Contact From Contact List (Real-Time)	✓	✗
Remove Contact From Contact List (Batched)	✓	✗
Trigger Transactional Email (Real-Time)	✓	✗
Trigger Transactional Email (Batched)	✓	✗
Unsubscribe Contact From Email Campaign	✓	✗
Trigger an External Event (Real-Time)	✓	✓
Trigger an External Event (Batched)	✓	✓
Upsert record in an RDS table (Real-Time)	✓	✗
Upsert record in an RDS table (Batched)	✓	✗
Delete record in an RDS table (Real-Time)	✓	✗
Delete record in an RDS table (Batched)	✓	✗

Enter a name for the action and select the action type from the drop-down menu.

The following section describes how to set up parameters and options for each action.

Batch limits

This connector uses batched requests to support high-volume data transfers to the vendor. For more information, see Batched Actions. Requests are queued until one of the following thresholds is met or the profile is published:

• Max number of requests: 1000
• Max time since oldest request: 4 minutes and 45 seconds
• Max size of requests: 10 MB

Add Contact to Contact List (Real-Time)

Parameters

Parameter	Description
Target Contact List	Required The contact list to add the contact to. If you know the ID of the target contact list and want to configure it manually, use a custom value.
Contact Data	Required The field and corresponding field data to identify the contact. For more information, see Emarsys: Core API Reference.

Add Contact to Contact List (Batched)

Parameters

Parameter	Description
Target Contact List	Required The contact list to add the contact to. If you know the ID of the target contact list and want to configure it manually, use a custom value.
Contact Data	Required The field and corresponding field data to identify the contact. For more information, see Emarsys: Core API Reference.

Create or Update Email Contact (Real-Time)

Parameters

Parameter	Description
Create If Not Exists	When enabled, if the contact does not exist, it is created automatically.
Contact Identifier Data	Required This is the field used to identify a contact. If you know the ID of the target contact field and want to configure it manually, use a custom value.
Contact Data	Required The field and corresponding field data to identify the contact. At least one field is required to identify the contact. The only date format supported by the contact fields is YYYY-MM-DD. Some contact fields have limited acceptable values. For more information, see Emarsys: Core API Reference. If you know the ID of the target contact field and want to configure it manually, use a custom value.

Optional

Parameter	Description
Source ID	An ID assigned to a customer’s external application, and is used to identify contacts created or modified by the external applications.

Create or Update Email Contact (Batched)

Parameters

Parameter	Description
Create If Not Exists	When enabled, if the contact does not exist, it is created automatically.
Contact Identifier Data	Required This is the field used to identify a contact. If you know the ID of the target contact field and want to configure it manually, use a custom value.
Contact Data	Required The field and corresponding field data to identify the contact. At least one field is required to identify the contact. The only date format supported by the contact fields is YYYY-MM-DD. Some contact fields have limited acceptable values. For more information, see Emarsys: Core API Reference. If you know the ID of the target contact field and want to configure it manually, use a custom value.

Optional

Parameter	Description
Source ID	An ID assigned to a customer’s external application, and is used to identify contacts created or modified by the external applications.

Remove Contact From Contact List (Real-Time)

Parameters

Parameter	Description
Target Contact List	Required The contact list to add the contact to. If you know the ID of the target contact list and want to configure it manually, use a custom value.
Contact Data	Required The field and corresponding field data to identify the contact. If you know the ID of the target contact list and want to configure it manually, use a custom value. For more information, see Emarsys: Core API Reference.

Remove Contact From Contact List (Batched)

Parameters

Parameter	Description
Target Contact List	Required The contact list to add the contact to. If you know the ID of the target contact list and want to configure it manually, use a custom value.
Contact Data	Required The field and corresponding field data to identify the contact. If you know the ID of the target contact list and want to configure it manually, use a custom value. For more information, see Emarsys: Core API Reference.

Trigger Transactional Email (Real-Time)

Parameters

Parameter	Description
External Event	Required Select the event set to trigger email.
Contact Data	Required The field and corresponding field data to identify the contact. If you know the ID of the target contact list and want to configure it manually, use a custom value.

Optional

Parameter	Description
Content Personalization Data	Optional Placeholder in email and the value to replace it with.

Trigger Transactional Email (Batched)

Parameters

Parameter	Description
External Event	Required Select the event set to trigger email.
Contact Data	Required The field and corresponding field data to identify the contact. If you know the ID of the target contact list and want to configure it manually, use a custom value.

Optional

Parameter	Description
Content Personalization Data	Optional Placeholder in email and the value to replace it with.

Unsubscribe Contact From Email Campaign

Parameters

Parameter	Description
Launch List ID	(Required) Provide the launch list ID from the unsubscribe link in email.
Email Campaign ID	(Required) Provide the email campaign ID from the unsubscribe link in email.
Contact ID	(Required) Map a randomly generated string to contact ID. Provided by unsubscribe link in email.

Trigger an External Event (Real-Time)

Parameters

Parameter	Description
External Event	Select the event to trigger.
Contact Data	Required The field and corresponding field data to identify the contact. If you know the ID of the target contact list and want to configure it manually, use a custom value. For more information, see Emarsys: Core API Reference.

Optional

Parameter	Description
External Event Data	The external data used for the trigger.
Template Variables	Provide template variables as data input for Templates. For more information, see Connector template variables. Name nested template variables with the dot notation (for example: items.name). Nested template variables are typically built from data layer list attributes.
Templates	Provide templates to be referenced in External Event Data. For more information, see About connector templates. Templates are injected by name with double curly braces into supported fields. For example, {{SomeTemplateName}}.

Trigger an External Event (Batched)

Parameters

Parameter	Description
External Event	Select the event to trigger.
Contact Data	Required The field and corresponding field data to identify the contact. If you know the ID of the target contact list and want to configure it manually, use a custom value. For more information, see Emarsys: Core API Reference.

Optional

Parameter	Description
External Event Data	The external data used for the trigger.
Template Variables	Provide template variables as data input for Templates. For more information, see Connector template variables. Name nested template variables with the dot notation (for example: items.name). Nested template variables are typically built from data layer list attributes.
Templates	Provide templates to be referenced in External Event Data. For more information, see About connector templates. Templates are injected by name with double curly braces into supported fields. For example, {{SomeTemplateName}}.

Upsert record in an RDS table (Real-Time)

Parameters

Parameter	Description
Connection Name	The name of the connection to the relational data service (RDS) .
Table Name	The name of the table in the RDS.
Table Records	The attributes to include in the new or updated record. Map each attribute to a column in the table.

Upsert record in an RDS table (Batched)

Parameters

Parameter	Description
Connection Name	The name of the connection to the RDS.
Table Name	The name of the table in the RDS.
Table Records	The attributes to include in the new or updated record. Map each attribute to a column in the table.

Delete record in an RDS table (Real-Time)

Parameters

Parameter	Description
Connection Name	The name of the connection to the RDS.
Table Name	The name of the table in the RDS.
Table Records	The attributes that identify the record to delete. Map each attribute to a column in the table.

Delete record in an RDS table (Batched)

Parameters

Parameter	Description
Connection Name	The name of the connection to the RDS.
Table Name	The name of the table in the RDS.
Table Records	The attributes that identify the record to delete. Map each attribute to a column in the table.