Ontraport Connector Setup Guide | Server-Side Connectors

Connector Actions

Action Name	AudienceStream	EventStream
Create a Contact	✓	✗
Update a Contact	✓	✗
Delete a 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:

API key
- In order to get started making requests on our API, you must obtain a unique API key and App ID.
- These credentials can be requested in your Administration settings.
- For more information, see Ontraport Introduction.
App ID
- In order to get started making requests on our API, you must obtain a unique API key and App ID.
- These credentials can be requested in your Administration settings.
- For more information, see Ontraport Introduction.

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 - Create a Contact

Parameters

Parameter	Description
First Name	String. The contact’s first name. For more information, see Create a Contact.
Last Name	String. The contact’s last name.
Email	String. The contact’s email address.
F-Referrer	Integer (number). The affiliate ID of the first affiliate to refer the contact.
L-Referrer	Integer (number). The affiliate ID of the last affiliate to refer the contact.
Address	String. The contact’s postal address.
Address 2	String. A second address field which is generally used for storing suite or unit numbers.
City	String. The contact’s city.
State	String. The contact’s state.
Zip	String. The contact’s postal code.
Country	String. The contact’s country.
Birthday	Timestamp (number). The contact’s birthday, measured in seconds from the Unix Epoch.
Priority	Integer (number). The contact’s priority. High = > `8` Medium = > `9` Low = > `10` None = > `0`
Status	Integer (number). The contact’s Sales Stage. `1` = > Closed - Lost `2` = > Closed - Won `3` = > Committed `4` = > Consideration `5` = > Demo Scheduled `6` = > Qualified Lead `7` = > New Prospect
Cell Phone	String. The contact’s mobile phone number.
Home Phone	String. The contact’s home phone number.
SMS Number	String. The mobile number where the contact prefers to receive text messages.
Office Phone	String. The contact’s office phone number.
Fax	String. The contact’s fax number.
Company	String. The company the contact is affiliated with.
Title	String. The contact’s job title.
Website	String. The contact’s website.
Bulk Mail	Integer (number). A flag that indicates a contact’s bulk email status. `0` = > Transactional Only `1` = > Opted-in `2` = > Double opt-in `-2` = > hard bounce `-5` = > Under review You can only set the value to zero (`0`) through the API. You cannot manually opt-in a contact who has opted to receive only transactional mail.
Bulk SMS	Integer (number). A flag that indicates whether or not a contact is opted in to receive bulk texts. 0 = > Opted-out 1 = > Opted-in 2 = > Double opt-in -2 = > hard bounce You can only set the value to 0 through the API. You cannot manually opt-in a contact who has opted out.
New Lead Source	Integer/string. The lead source for the first tracking URL the contact arrived from. This field accepts the lead source name if use UTM Names has a value of true, and ID if it is not passed or has a value of false UTM variables passed by name will be created if they do not exist.
New Content	integer/string. The content for the first tracking URL the contact arrived from. This field accepts the contact name if use UTM Names has a value of true, and ID if it is not passed or has a value of false. UTM variables passed by name will be created if they do not exist.
New Medium	Integer/string. The medium for the first tracking URL the contact arrived from. This field accepts the medium name if use UTM Names has a value of true, and ID if it is not passed or has a value of false. UTM variables passed by name will be created if they do not exist.
New Campaign	Integer/string. The tracking campaign for the first tracking URL the contact arrived from. This field accepts the tracking campaign name if use UTM Names has a value of true, and ID if it is not passed or has a value of false. UTM variables passed by name will be created if they do not exist.
New Term	Integer/string. The term for the first tracking URL the contact arrived from. This field accepts the tracking campaign name if use UTM Names has a value of true, and ID if it is not passed or has a value of false. UTM variables passed by name will be created if they do not exist.
Last Lead Source	Integer/string. The lead source for the last tracking URL the contact arrived from. This field accepts the lead source name if use UTM Names has a value of true, and ID if it is not passed or has a value of false. UTM variables passed by name will be created if they do not exist.
Last Content	Integer/string. The content for the last tracking URL the contact arrived from. This field accepts the content name if use UTM Names has a value of true, and ID if it is not passed or has a value of false. UTM variables passed by name will be created if they do not exist.
Last Medium	Integer/string. The medium for the last tracking URL the contact arrived from. This field accepts the medium name if use UTM Names has a value of true, and ID if it is not passed or has a value of false. UTM variables passed by name will be created if they do not exist.
Last Campaign	Integer/string. The tracking campaign for the last tracking URL the contact arrived from. This field accepts the tracking campaign name if use UTM Names has a value of true, and ID if it is not passed or has a value of false. UTM variables passed by name will be created if they do not exist.
Last Term	Integer/string. The term for the last tracking URL the contact arrived from. This field accepts the tracking campaign name if use UTM Names has a value of true, and ID if it is not passed or has a value of false. UTM variables passed by name will be created if they do not exist.
Use UTM Names	`True` or `false`. Used to indicate that UTM variables will be passed by name rather than ID. Default value is `false`.
Referral Page	String. The page the contact was referred from.
Affilliate Sales	Integer (number). If the contact is an affiliate, the total number of affiliate sales.
Affiliate Amount	Double (string). If the contact is an affiliate, the total amount of affiliate sales.
Program ID	Integer (number). For affiliates, the partner program ID.
Affiliate Paypal	String. Affiliate email address for PayPal payments.
Timezone	String. The contact’s timezone.
Number Purchased	Integer (number). The contact’s total orders.

Action - Update a Contact

Parameters

Parameter	Description
Contact ID	The ID of the contact to update is required. The other fields should only be used if you want to change the existing value. For more information, see Update a Contact.
First Name	String. The contact’s first name.
Last Name	String. The contact’s last name.
Email	String. The contact’s email address.
F-Referrer	Integer (number). The affiliate ID of the first affiliate to refer the contact.
L-Referrer	Integer (number). The affiliate ID of the last affiliate to refer the contact.
Address	String. The contact’s postal address.
Address 2	String. A second address field which is generally used for storing suite or unit numbers.
City	String. The contact’s city.
State	String. The contact’s state.
Zip	String. The contact’s postal code.
Country	String. The contact’s country.
Birthday	Timestamp (number). The contact’s birthday, measured in seconds from the Unix Epoch.
Priority	Integer (number). The contact’s priority. High = > `8` Medium = > `9` Low = > `10` None = > `0`
Status	Integer (number). The contact’s sales stage. `1` = > Closed - Lost `2` = > Closed - Won `3` = > Committed `4` = > Consideration `5` = > Demo Scheduled `6` = > Qualified Lead `7` = > New Prospect
Cell Phone	String. The contact’s mobile phone number.
Home Phone	String. The contact’s home phone number.
SMS Number	String. The mobile number where the contact prefers to receive text messages.
Office Phone	String. The contact’s office phone number.
Fax	String. The contact’s fax number.
Company	String. The company the contact is affiliated with.
Title	String. The contact’s job title.
Website	String. The contact’s website.
Bulk Mail	Integer (number). A flag that indicates a contact’s bulk email status. `0` = > Transactional Only `1` = > Opted-in `2` = > Double opt-in `-2` = > hard bounce `-5` = > Under review You can only set the value to `0` through the API. You cannot manually opt-in a contact who has opted to receive only transactional mail.
Bulk SMS	Integer (number). A flag that indicates whether or not a contact is opted in to receive bulk texts. 0 = > Opted-out 1 = > Opted-in 2 = > Double opt-in -2 = > hard bounce You can only set the value to `0` through the API. You cannot manually opt-in a contact who has opted out.
New Lead Source	Integer/string. The lead source for the first tracking URL the contact arrived from. This field accepts the lead source name if use UTM Names has a value of true, and ID if it is not passed or has a value of false. UTM variables passed by name will be created if they do not exist.
New Content	integer/string. The content for the first tracking URL the contact arrived from. This field accepts the contact name if use UTM Names has a value of true, and ID if it is not passed or has a value of false. UTM variables passed by name will be created if they do not exist.
New Medium	Integer/string. The medium for the first tracking URL the contact arrived from. This field accepts the medium name if use UTM Names has a value of true, and ID if it is not passed or has a value of false. UTM variables passed by name will be created if they do not exist.
New Campaign	Integer/string. The tracking campaign for the first tracking URL the contact arrived from. This field accepts the tracking campaign name if use UTM Names has a value of true, and ID if it is not passed or has a value of false UTM variables passed by name will be created if they do not exist.
New Term	Integer/string. The term for the first tracking URL the contact arrived from. This field accepts the tracking campaign name if use UTM Names has a value of true, and ID if it is not passed or has a value of false. UTM variables passed by name will be created if they do not exist.
Last Lead Source	Integer/string. The lead source for the last tracking URL the contact arrived from. This field accepts the lead source name if use UTM Names has a value of true, and ID if it is not passed or has a value of false. UTM variables passed by name will be created if they do not exist.
Last Content	Integer/string. The content for the last tracking URL the contact arrived from. This field accepts the content name if use UTM Names has a value of true, and ID if it is not passed or has a value of false. UTM variables passed by name will be created if they do not exist.
Last Medium	Integer/string. The medium for the last tracking URL the contact arrived from. This field accepts the medium name if use UTM Names has a value of true, and ID if it is not passed or has a value of false. UTM variables passed by name will be created if they do not exist.
New Campaign	Integer/string. The tracking campaign for the first tracking URL the contact arrived from. This field accepts the tracking campaign name if use UTM Names has a value of true, and ID if it is not passed or has a value of false UTM variables passed by name will be created if they do not exist.
Last Term	Integer/string. The term for the last tracking URL the contact arrived from. This field accepts the tracking campaign name if use UTM Names has a value of true, and ID if it is not passed or has a value of false. UTM variables passed by name will be created if they do not exist.
Use UTM Names	True or false. Used to indicate that UTM variables will be passed by name rather than ID. Default value is `false`.
Referral Page	String. The page the contact was referred from.
Affilliate Sales	Integer (number) If the contact is an affiliate, the total number of affiliate sales.
Affiliate Amount	Double (string). If the contact is an affiliate, the total amount of affiliate sales.
Program ID	Integer (number). For affiliates, the partner program ID.
Affiliate Paypal	String. Affiliate email address for PayPal payments.
Timezone	String. The contact’s timezone.
Number Purchased	Integer (number). The contact’s total orders.

Action - Delete a Contact

Parameters

Parameter	Description
Contact ID	ID of the contact to be deleted. For more information, see Delete a Specific Contact.