Ambassador

The Ambassador Developer Hub

Welcome to the Ambassador developer hub. You'll find comprehensive guides and documentation to help you start working with Ambassador as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Integration: Embeddable Form

This form allows people to sign up to become an ambassador and track referral form signups for the provided campaign. Once Ambassador processes the form, we forward the user to a page you designate (such as a thank-you page or a Salesforce Web-to-Lead URL) along with all of the form's POST data.

The example code is pre-filled with campaign information for you, but you may want to customize the fields and their respective values.

Required Fields:

  • mbsy_username
  • mbsy_campaign_uid
  • email
Variable
Description
Options
Default

mbsy_username

Your company's username

mbsy_campaign_uid

Your campaign's ID

email

Your customer's email address

mbsy_short_code

Referrer's "mbsy" shortcode

revenue

Revenue amount of the event

mbsy_transaction_uid

Unique transaction ID from the event

mbsy_uid

Your customer's internal unique ID

first_name

Your customer's first name

last_name

Your customer's last name

mbsy_street

Your customer's address

mbsy_state

Your customer's state

mbsy_zip

Your customer's zip code

mbsy_country

Your customer's country

mbsy_status

Your customer's status if you have opted to use the ambassador/get method (mbsy_api_method = "ambassador/get"). Valid values are enrolled, prospect, banned and unsubscribed.

mbsy_custom1

Custom field - related to ambassador

mbsy_custom2

Custom field - related to ambassador

mbsy_custom3

Custom field - related to ambassador

mbsy_email_new_ambassador

Email login credentials to new ambassadors

1 - yes
0 - no

1

mbsy_deactivate_new_ambassador

New ambassadors created are deactivated

1 - yes
0 - no

0

mbsy_auto_create

If the customer is not an ambassador, create them

1 - yes
0 - no

1

mbsy_return_ambassador

Return new ambassador's memorable share link

"GET"
"POST"

disabled

mbsy_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 mbsy_add_to_group_id=-1, then ambassador will not be added to any group

mbsy_api_method

API method to call. When "ambassador/get" method is used, following parameters are ignored: mbsy_campaign_uid, revenue, mbsy_transaction_uid

event/record
ambassador/get

event/record

mbsy_forward_url

page to forward to

mbsy_form_method

method to use when sending data to the forward url

get
post

post

mbsy_sandbox

Create customer in sandbox

1 - yes
0 - no

 <form action="https://mbsy.co/embed/v2/form" method="POST">

    <input type="hidden" name="mbsy_username" value="[[app:username]]">
    <input type="hidden" name="mbsy_campaign_uid" value="0000">
    <input type="hidden" name="revenue" value="0">
    <input type="hidden" name="mbsy_email_new_ambassador" value="1">
    <input type="hidden" name="mbsy_forward_url" value="http://google.com">
    <input type="hidden" name="mbsy_api_method" value="event/record">

    <label for="first_name">First Name</label>
    <input  id="first_name" maxlength="40" name="first_name" size="20" type="text" />
    <br/>
    <label for="last_name">Last Name</label>
    <input  id="last_name" maxlength="80" name="last_name" size="20" type="text" />
    <br/>
    <label for="email">Email</label>
    <input  id="email" maxlength="80" name="email" size="20" type="text" />
    <br/>
    <label for="phone">Phone</label>
    <input  id="phone" maxlength="40" name="mbsy_custom1" size="20" type="text" />
    <br/>
    <label for="company">Company</label>
    <input  id="company" maxlength="40" name="mbsy_custom2" size="20" type="text" />
    <br/>

    <input type="submit" name="submit">

    </form>

Form