Ambassador Connector Setup Guide

Ambassador Connector Setup Guide

by ‎12-10-2018 05:42 PM - edited ‎12-14-2018 02:27 PM (52 Views)

This article describes how to set up the Ambassador connector in your Universal Data Hub account.

In this article:

Table of Contents Placeholder

Connector Actions

Action Name AudienceStream EventStream
Record Campaign Referral Event
Update Ambassador
Add Ambassador Commission
Remove Contact

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:

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 - Record Campaign Referral Event

Parameters

Parameter Description
Email Address
Campaign UID
  • Your campaign's ID. Required if product ID is not used.
Product ID
  • Your product ID, which is assigned to one of your campaigns.
  • Can be used instead of Campaign UID.
  • Required if Campaign UID is not used.
Short Code
  • Referrer's "mbsy" shortcode, required for initial commissions.
Revenue
  • Revenue amount of the event.
  • Default value is 0.
Transaction UID
  • Unique transaction ID for the event.
IP Address
  • Customer's IP address.
Customer UID
  • Your customer's internal unique ID.
First Name
  • Your customer's first name.
Last Name
  • Your customer's last name.
Custom Field 1
  • Custom field. Related to ambassador.
Custom Field 2
  • Custom field. Related to ambassador.
Custom Field 3
  • Custom field. Related to ambassador.
Email New Ambassador
  • Email login credentials to new ambassadors (1=yes, 0=no).
  • Default value is 1.
Deactivate New Ambassador
  • New ambassadors created are deactivated (1=yes, 0=no).
  • Default value is 0.
Auto Create Customer
  • If the customer is not an ambassador, create them (1=yes, 0=no).
  • Default value is 0 if you signed up for Ambassador after Nov 5 2013, otherwise default value is 1.
Add to Group ID
  • Define which group(s) new ambassadors will be created in.
  • Using this parameter will override default group settings.
  • Group IDs should be separated by commas.
  • If add_to_group_id= -1, then ambassador will not be added to any group.
Event Data 1
  • Custom field.
  • Related to the event.
Event Data 2
  • Custom field.
  • Related to the event.
Event Data 3
  • Custom field.
  • Related to the event.
Commission is Approved
  • Commission status (1=approved, 0=pending).
  • Entering a value will override the campaign's auto approve setting; otherwise, the campaign's setting will be used if not provided.
Street
  • Your customer's street.
City
  • Your customer's city.
State
  • Your customer's state.
Postal Code
  • Your customer's postal code.
Country
  • Your customer's country.
Phone
  • Your customer's phone number.

Action - Update Ambassador

Parameters

Parameter Description
UID
Email Address
  • Your ambassador's email address.
  • Required if UID not provided.
  • If both email and UID are provided, UID will take precedence.
New Email Address
  • New email address for the ambassador.
New UID
  • New UID for the ambassador.
First Name
  • New first name for the ambassador.
Last Name
  • New last name for the ambassador.
Custom Field 1
  • New value for custom field 1.
Custom Field 2
  • New value for custom field 2.
Custom Field 3
  • New value for custom field 3.
Deactivate Ambassador
  • 1=deactivate ambassador. 0=activate ambassador.
  • Default value is 0.
  • Deactivation will change the ambassador's status to 'Banned'.
Send Welcome Email
  • (1=yes, 0=no).
Street
  • New street for the ambassador.
City
  • New city for the ambassador.
State
  • New state for the ambassador.
Postal Code
  • New postal code for the ambassador.
Country
  • New country for the ambassador.
Phone
  • New phone for the ambassador.
Paypal Email
  • New PayPal email address for the ambassador.
Company
  • New company name for the ambassador.
Set Groups
  • Define which group(s) existing ambassadors will be put in.
  • Using this parameter will override default group settings and an ambassador's current groups.
  • Group IDs should be separated by commas.

Action - Add Ambassador Commission

Parameters

Parameter Description
UID
Ambassador Email
  • Your ambassador's email address.
  • Required if UID not used. If both are present, UID takes precedence.
Campaign UID
  • Your campaign's ID.
Commission Amount
  • Amount of commission.
Customer Email
  • Your customer's email address.
First Name
  • Your customer's first name.
Last Name
  • Your customer's last name.
Revenue Amount
  • Amount of revenue.
Transaction UID
  • Unique transaction ID for commission.
Referrer UID
  • Your referrer's internal unique ID.
Customer UID
  • Your customer's internal unique ID.
Commission is Approved
  • 1=approved commission, 0=pending commission.
Email New Ambassador
  • Email login credentials to new ambassadors (1=yes, 0=no).
Deactivate New Ambassador
  • New ambassadors create are deactivated (1=yes, 0=no).
Event Data 1
  • Custom field.
  • Related to event/commission.
Event Data 2
  • Custom field.
  • Related to event/commission.
Event Data 3
  • Custom field.
  • Related to event/commission.

Action - Remove Contact

Parameters

Parameter Description
Email Address