Tokens/URL Parameters

Tokens are data automatically generated by a Web server and can be passed as parameters over a URL or grabbed by another method such as our scripts. Below is a quick reference to our tokens/URL parameters. Note that depending on your goal, certain tokens may be required.

Identification Tokens/Parameters

Token

Notes

firstname

Contact’s first name

lastname

Contact’s last name

fullname

Full name can be sent as one field and will try to be parsed into first and last name

email

Contact's email address

programidentifier

Program's ID, Name, or Title

externalidentifier

Typically something unique to the contact like customer/order number

conversionstatus

Sets the status of the Referral upon conversion (Pending, Qualified, Approved, Denied). By default follows your Program Rules.

status

Status of the Referral (Qualified, Approved, Denied). Used when updating an existing Referral.

amount

Order amount/total

referralcode

A Member's referral code

phone

Contact's phone number

referralkey_email

Referral's email address. Used when updating an existing Referral.

referralkey_externalid

Referral's external ID. Used when updating an existing Referral.

referralkey_id

Referral's internal Referral Rock ID. Used when updating an existing Referral.

note

Note associated with the contact

publicnote

Public note associated with the contact

preferredcontact

Contact’s selected preferred contact method

companyname

Contact's company name

customreferraloverrideurl 

Overrides where the Member's referral link sends the Referral

birthdate

Contact's birth date

customoption1name

Name of the first custom drop down field

customoption1value

Value of the first custom drop down field

customoption2name

Name of the second custom drop down field

customoption2value

Value of the second custom drop down field

customtext1name

Name of the first custom text box

customtext1value

Value of the first custom text box

customtext2name

Name of second first custom text box

customtext2value

Value of the second custom text box

customtext3name

Name of third first custom text box

customtext2value

Value of the third custom text box

Control Tokens/Parameters

Token

Default Value

Values

Notes

sendregemailonadd

programrules

programrules, true, false

If value = program rules, it follows the rules of the program

updatemember

false

true, false

If member exists, it will update member with demographic info provided

view

site

site, widget, iframe

Redirects to either site, widget or iframe

addmember

true

true, false

Adds member if user does not exist by external id or email.

deniedpage

goes to codenotavailable.aspx page on your Referral Rock site

String URL

Redirects to page if access is denied

debug

true

true, false

Instead of redirecting, displays access link generated and all debug info, parameters, on page.

useemailonnamemissing

true

true, false

If the first name is missing, we'll replace it with the email address.

directregistrationondenied

true

true, false

If we fail to login/add user we will direct the link to the registration page of that program. Note, the programidentifier must be set correctly.


How did we do?


Powered by HelpDocs

Powered by HelpDocs