APSIS Connector Setup Guide | Server-Side Connectors

Connector Actions

Action Name	AudienceStream	EventStream
Create Subscriber and Add to Mailing List (Queued)	✓	✗
Update Subscriber (Queued)	✓	✗
Add Subscriber to Mailing List	✓	✗
Remove Subscriber from Mailing List	✓	✗
Delete Subscriber (Queued)	✓	✗
Send Transactional Email	✓	✗

Configure Settings

Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector.

After adding the connector, configure the following settings:

API Key
- To get an API key, log in to your APSIS Pro account and select the Account section.
- Find the API Keys link and click to generate a new API key.
- One account can have multiple API keys.
- You can manage your keys using the Account Settings section in APSIS Pro.
- For more information, see APSIS: Getting Started

Action Settings - Parameters and Options

Click Next or go to the Actions tab. This is where you configure connector actions.

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

Action - Create Subscriber and Add to Mailing List (Queued)

Batch Limits

This action 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: 10
Max time since oldest request: 1 minutes
Max size of requests: 1 MB

Parameters

Parameter	Description
Mailing List	The ID of the list the subscriber should be added to. If you know mailing list ID, you can enter it as Custom Value. Select the list the subscriber should be added to, or provide list ID directly. For more information, see SubscriberService.CreateSubscriber.
Create Mode	If the subscriber’s account already exists and this parameter is set to “Create or Update”, then the subscriber’s data will be updated. It is not possible to update existing subscriber when subscribing with double opt-in.
Country code	The subscriber’s country code.
Desired format	The subscriber’s desired format.
Email address	Required. The subscriber’s email address.
External ID	The subscriber’s external ID.
Name	The name of the subscriber.
Password	The subscriber’s password.
Phone number	The subscriber’s phone number.
Demographic Data	The subscriber’s list of demographic data fields. The keys and possible values of data fields are defined in the APSIS account management console.
Template Variables	Optional. Provide template variables for Demographic Data. For more information, see Template Variables Guide Name nested template variables with the dot notation. Example: `items.name` Nested template variables are typically built from data layer list attributes.
Templates	Optional: provide templates to be referenced in Demographic Data. For more information, see Templates Guide. Templates are injected by name with double curly braces into supported fields. Example: `{{SomeTemplateName}}`

Action - Update Subscriber (Queued)

Batch Limits

Max number of requests: 10
Max time since oldest request: 1 minutes
Max size of requests: 1 MB

Parameters

Parameter	Description
Country code	The subscriber’s country code.
Desired format	The subscriber’s desired format.
Email address	Required. The subscriber’s email address
Name	The name of the subscriber.
Password	The subscriber’s password.
Phone number	The subscriber’s phone number.
User ID	The subscriber’s ID. For more information, see Update Subscribers
Demographic Data	The subscriber’s list of demographic data fields. The keys and possible values of data fields are defined in the account management console.
Template Variables	Optional. Provide template variables for Demographic Data. For more information see Template Variables Guide. Name nested template variables with the dot notation. Example: `items.name` Nested template variables are typically built from data layer list attributes.
Templates	Optional: provide templates to be referenced in Demographic Data. For more information see Template Variables Guide. Templates are injected by name with double curly braces into supported fields. Example: `{{SomeTemplateName}}`

Action - Add Subscriber to Mailing List

Parameters

Parameter	Description
Mailing List	Select the list the subscriber should be added to, or provide list ID directly. For more information, see SubscriberService.CreateSubscriber. If you know mailing list ID, you can enter it as Custom Value
Subscriber’s Email	Required. The subscriber’s email address
Subscriber’s ID	The subscriber’s ID. For more information, see Update Subscribers

Action - Remove Subscriber from Mailing List

Parameters

Parameter	Description
Mailing List	Select the list the subscriber should be added to, or provide list ID directly. For more information, see SubscriberService.CreateSubscriber. If you know mailing list ID, you can enter it as Custom Value
Subscriber’s Email	Required. The subscriber’s email address
Subscriber’s Id	The subscriber’s ID. For more information, see Update Subscribers

Action - Delete Subscriber (Queued)

Batch Limits

Max number of requests: 10
Max time since oldest request: 1 minutes
Max size of requests: 1 MB

Parameters

Parameter	Description
Subscriber’s Email	Required. The subscriber’s email address

Action - Send Transactional Email

Parameters

Parameter	Description
Transactional Project	Select the transactional project. ID of the project. For more information, see Send Transactional Email
Disable inactive projects	True or false indicating if sending should be allowed when project is inactive Default value is true.
Country code	The subscriber’s country code.
Demographic data for HTML	The subscriber’s list of demographic data fields. The keys and possible values of data fields are defined in the APSIS account management console.
Desired format	The subscriber’s desired format.
Email address	Required. The subscriber’s email address
External ID	The subscriber’s external ID.
Name	The name of the subscriber.
Phone number	The subscriber’s phone number.
Send Date	Send date.
Sending Type	Possible values: m - marketing t - transactional (default)
Demographic Data	The subscriber’s list of demographic data fields. The keys and possible values of data fields are defined in the APSIS account management console.
Template Variables	Optional. Provide template variables for Demographic Data. For more information, see Template Variables Guide. Name nested template variables with the dot notation. Example: `items.name` Nested template variables are typically built from data layer list attributes.
Templates	Optional: provide templates to be referenced in Demographic Data. For more information, see Templates Guide. Templates are injected by name with double curly braces into supported fields. Example: `{{SomeTemplateName}}`