Swrve List Destination

MessageGears delivers audience data to Swrve User Lists via API. Swrve User Lists are named collections of users that can be referenced within Swrve for targeting in-app messages, push notifications, and other campaign types.

info

This destination is primarily used by organizations running both MessageGears and Swrve. Swrve API credentials are configured by MessageGears Support during initial setup.

Prerequisites

Before setting up the Swrve List destination, make sure the following are in place:

• An active Swrve account with User List API access
• Swrve API credentials configured by MessageGears Support
• A MessageGears audience or Blueprint that includes Swrve user identifiers — see Creating and Editing Audiences

Step 1: Configure the destination

Swrve API credentials are configured by MessageGears Support on your behalf. Contact Support and provide your Swrve project credentials to get the destination set up.

Step 2: Select or create a User List

When creating an External Campaign to the Swrve List destination, you will select which Swrve User List to populate. Existing lists are shown in a dropdown.

If the list you need does not yet exist, you can create one directly from the campaign settings:

1. In the Destination settings, click Create New User List.
2. Provide:
   • List ID: A unique identifier using only lowercase letters, numbers, underscores, and hyphens
   • Name: A human-friendly display name for the list
   • Description (optional): Notes about the list's purpose
3. Click Create to save the new list, then select it as your destination.

Step 3: Configure identifier mapping

When setting up the campaign, specify how your audience data maps to Swrve users:

Campaign Setting	Description
ID Type	How users are identified in Swrve: Swrve Id (internal Swrve user ID) or External Id (your own user identifier)
ID Column	The column in your audience data that contains the identifier value

Choose Swrve Id if your audience data contains Swrve's internal user IDs. Choose External Id if your audience uses your own user identifiers (e.g., CRM ID) that are mapped to Swrve users.

Step 4: Build your audience in MessageGears

Use the MessageGears audience builder or a Blueprint to define the segment you want to add to the Swrve User List. Your audience must include the identifier column that corresponds to your configured ID Type.

For guidance on building audiences and Blueprints, see:

• Creating and Editing Audiences
• Blueprints for Campaign Segmentation

Step 5: Create an External Campaign targeting the Swrve List destination

Once your audience is defined and the list is selected, create an External Campaign:

1. Navigate to Campaigns > External.
2. Under Settings, select your audience or Blueprint.
3. In the Destination dropdown, select your Swrve List destination and choose the target User List.
4. Set your schedule (one-time or recurring) and click Save or Launch.

For a full walkthrough of the External Campaign workflow, see External Campaigns.

Troubleshooting

Symptom	Likely cause	Resolution
User List not appearing in dropdown	List does not exist yet	Create a new list using the Create New User List option
Users not added to the list in Swrve	Invalid API credentials or mismatched identifiers	Contact MessageGears Support to verify Swrve API configuration
Low or no match rate	Incorrect ID Type or identifier values not matching Swrve records	Confirm the ID Type matches the identifier format in your audience data
Campaign fails to publish	Destination misconfigured	Contact MessageGears Support

For additional help, contact MessageGears Support.