Configure campaigns for Listrak SMS¶

Listrak SMS is an automation platform for audience activation through mobile messaging campaigns and personalized SMS marketing.

Use the Listrak SMS REST API to manage SMS profiles in Listrak SMS.

Get details¶

Review the following details before configuring credentials for Listrak SMS and before configuring Amperity to send phone numbers and SMS profile attributes to Listrak SMS.

	Credential settings You must configure this destination for SMS profiles: SMS client ID and client secret A client ID and secret for an SMS integration that is already set up in Listrak SMS. Tip The client ID and client secret are available from the Integrations menu in Listrak SMS. Open the Integrations menu, select Integrations Management, and then from the Integrations page choose an integration. The client ID and client secret are on the Setup tab.
	SMS lists and Listrak An active SMS list must exist in Listrak SMS before Amperity can send SMS profiles to that list. Log in to your Listrak account . Open the Contacts menu, and then choose SMS Lists. On the SMS Lists page, review the list of Active lists or click New list to add a list. The List Name in Listrak SMS is the value for the Phone list ID configuration setting in Amperity.
	Define custom SMS profile attributes Custom SMS profile attributes must be created in Listrak SMS before Amperity can send custom attributes. Up to fifty custom attributes may be defined in Listrak SMS. Important Custom attributes must be configured as custom profile fields before Amperity can send custom attributes with Listrak SMS SMS profiles. The attribute name in Amperity must match the profile field name in Listrak SMS. Attribute names are not case-sensitive. All custom attributes sent by Amperity must match a custom profile field that exists in Listrak SMS. Custom attributes are defined in the Listrak SMS user interface. Open the Contacts menu, and then choose Profile Fields. Click New Profile Field to add custom attributes. System fields–Birthday, Email Address, First Name, Last Name, and Postal Code–are pre-defined by Listrak SMS and cannot be modified. Phone Number is the primary identifier for each SMS profile and is required.
	Required configuration settings SMS list ID Required The SMS list ID for a list in Listrak SMS. The SMS list ID is available from the Listrak SMS user interface. Open the Contacts menu, and then choose SMS Lists. Open a list. The SMS list ID is available in the URL of the list after the equals symbol. Note Lists are available from the Contacts menu within the Listrak SMS user interface. Under SMS Contacts open the Contacts menu, and then choose SMS Lists. Listrak SMS uses a list named “Master List” by default, but allows custom lists to be created. Verify the name of the list in Listrak SMS before configuring this destination in Amperity. If you are not sure which lists should be managed by Amperity, work with your Listrak representative to determine the best approach for list management. Sender code ID A sender code associates your brand’s Listrak SMS account with SMS campaigns, such as broadcast, split tests, keyword, and subscription. The sender code ID is provided by Listrak SMS. Ask your Listrak SMS representative for the sender code if necessary.
	Audience configuration Use a query or a segment to build an audience to send to Listrak SMS. The phone field must be part of the audience. You may append additional profile attributes to the query or segment.

About Listrak SMS profile attributes¶

Listrak SMS uses phone numbers as the primary identifier for each SMS profile.

Listrak SMS has the following SMS pre-defined attributes to collect additional information about SMS profiles.

System fields

Birthday Use for date-based segmentation.
Email Address A contact attribute.
First Name and Last Name Use for personalization.
Postal Code Use for location targeting.

Use system attributes to personalize messages, such as adding a first name to an SMS message, and to filter messages to only those who match certain criteria.

Custom attributes

Enable the Include attributes that match custom profile fields field to sychronize all profile attributes in Amperity that match custom profile fields defined in Listrak SMS.

Important

Custom attributes must be configured as custom profile fields before Amperity can send custom attributes with Listrak SMS SMS profiles.

The attribute name in Amperity must match the profile field name in Listrak SMS. Attribute names are not case-sensitive.

All custom attributes sent by Amperity must match a custom profile field that exists in Listrak SMS.

Listrak SMS supports up to fifty custom SMS profile attributes. Use these to define additional SMS profile attributes to support your brand’s use cases.

Important

Each custom attribute must be defined in Listrak SMS before Amperity can send them with SMS profiles.

Custom attributes must be one of the following data types: Checkbox, Date, Number, or Text . Any custom attributes sent from Amperity must match one of these data types.

Configure credentials¶

Configure credentials for Listrak SMS before adding a destination.

An individual with access to Listrak SMS should use SnapPass to securely share “refresh token” details with the individual who configures Amperity.

To configure credentials for Listrak SMS

From the Settings page, select the Credentials tab, and then click the Add credential button.

In the Credentials settings dialog box, do the following:

From the Plugin dropdown, select Listrak SMS.

Assign the credential a name and description that ensures other users of Amperity can recognize when to use this destination.

The settings that are available for a credential vary by credential type. For the “listrak-sms” credential type, configure settings, and then click Save.

You must configure this destination for SMS profiles:

SMS client ID and client secret

A client ID and secret for an SMS integration that is already set up in Listrak SMS.

Tip

The client ID and client secret are available from the Integrations menu in Listrak SMS. Open the Integrations menu, select Integrations Management, and then from the Integrations page choose an integration. The client ID and client secret are on the Setup tab.

Reauthorize Amperity¶

You may need to reauthorize access to Listrak SMS. This is necessary when an authorization token has expired or when it has been removed by someone with permission to manage access within Listrak SMS. To reauthorize access to Listrak SMS, follow the steps to configure OAuth and create a new credential.

Add destination¶

Use a sandbox to configure a destination for Listrak SMS. Before promoting your changes, send a test audience, and then verify the results in Listrak SMS. After verifying the end-to-end workflow, push the destination from the sandbox to production.

To add a destination for Listrak SMS

	Open the Destinations page, select the New destinations button, and then select Campaign. To configure a campaign for Listrak SMS, do one of the following: Click the row in which Listrak SMS is located. Destinations list alphabetically and you can scroll up and down the list. Search for Listrak SMS. Start typing “list”. The list filters to show only matching destinations. Select “Listrak SMS”.
	Select the credential for Listrak SMS from the Credential dropdown, and then click Continue. Tip If there are any issues with destination connectivity, an error message will display in the destination setup dialog. If the destination saves successfully, the connection is ready for use.
	In the “Destination settings” dialog box, assign the destination a name and description that ensures other users of Amperity can recognize when to use this destination. Configure business user access By default a destination is available to all users who have permission to view personally identifiable information (PII). Enable the Admin only checkbox to restrict access to only users assigned to the Datagrid Operator and Datagrid Administrator policies. Enable the PII setting checkbox to allow limited access to PII for this destination. Use the Restrict PII access policy option to prevent users from viewing data marked as PII anywhere in Amperity and from sending data to downstream workflows.
	Configure the following settings, and then click “Save”. SMS list ID Required The SMS list ID for a list in Listrak SMS. The SMS list ID is available from the Listrak SMS user interface. Open the Contacts menu, and then choose SMS Lists. Open a list. The SMS list ID is available in the URL of the list after the equals symbol. Note Lists are available from the Contacts menu within the Listrak SMS user interface. Open the Contacts menu, and then choose SMS Lists. Listrak SMS uses a list named “Master List” by default, but allows custom lists to be created. Verify the name of the list in Listrak SMS before configuring this destination in Amperity. If you are not sure which lists should be managed by Amperity, work with your Listrak representative to determine the best approach for list management. Sender code ID A sender code associates your brand’s Listrak SMS account with SMS campaigns, such as broadcast, split tests, keyword, and subscription. The sender code ID is provided by Listrak SMS. Ask your Listrak SMS representative for the sender code if necessary. Audience primary key The primary key for the audience. Set to “phone”. Include attributes that match custom profile fields Select Include attributes that match custom profile fields to have Amperity synchronize all profile attributes in Amperity that match custom profile fields defined in Listrak SMS. Custom attributes must match the name of the custom profile field in Listrak and must be a supported Listrak data. Important Custom attributes must be configured as custom profile fields before Amperity can send custom attributes with Listrak SMS SMS profiles. The attribute name in Amperity must match the profile field name in Listrak SMS. Attribute names are not case-sensitive. All custom attributes sent by Amperity must match a custom profile field that exists in Listrak SMS. Campaign file settings Under Campaign settings select one of the following: Send audience list as separate files This option sends a standalone file for each treatment group sending an audience to Listrak SMS. Send audience lists as a single file This option consolidates all treatment groups into a single file before sending the audience to Listrak SMS.
	After configuring this destination users may send campaigns to Listrak SMS.

Customers, products, and orders¶

Configure Amperity to additional data sets–customers, products, orders, and order items–to Listrak SMS using SFTP.

Note

This option uses the SFTP destination that is built into Amperity and should follow the steps and requirements that are outlined in the Listrak SMS file import guide .

You can send the following sets of data to Listrak SMS.

Work with your Listrak SMS representatives to determine which of these sets will be useful for your workflows within Listrak SMS, and then verify that attributes sent from Amperity are mapped correctly to the appropriate data schema within Listrak SMS.