Affiliate::signup | TUNE Dev Hub

Jump to: POST Response Notes | API Call Builder

Affiliate sign-up action that executes the following steps:

Create affiliate
Create new affiliate user with the ID from the newly created affiliate
Save affiliate meta information
Perform fraud validation and calculate fraud score
Update affiliate status from active to pending if fraud score exceeds the fraud threshold
Send alert to network employee that affiliate and affiliate user have been created

= Required Parameter

Name

Type

Description

account

Object

Affiliate model object dataShow Supported Parameters

The following parameters are supported by this object.

Name	Type	Description
account_manager_id	Nullable Integer	The ID of the employee from the network who is assigned as the account manager for the affiliate
address1	Nullable String	The first line of the account's physical address
address2	Nullable String	The second line of the account's physical address
affiliate_tier_id	Nullable Integer	The ID of the affiliate tier to which this affiliate is assigned. If no value is present, the affiliate is in the default tier.
city	Nullable String	The city of the account's physical address
company	String	The company name of the affiliate
country	Nullable String	The country of the account's physical address
date_added	Datetime	The date this account was created
fax	Nullable String	The fax number of the affiliate
fraud_activity_alert_threshold	Nullable Integer	The activity fraud threshold (percent out of 100) at which point an alerts will be generated for this account when its recent activity is flagged as potentially fraudulent. Applicable only if the "affiliate_fraud_activity" preference is enabled. For more information, reference our article on Affiliate Activity Fraud.
fraud_activity_block_threshold	Nullable Integer	The activity fraud threshold (percent out of 100) at which point the account will be automatically blocked (status set to "blocked") when its recent activity is flagged as potentially fraudulent. Applicable only if the "affiliate_fraud_activity" preference is enabled. For more information, reference our article on Affiliate Activity Fraud.
fraud_activity_score	Nullable Integer	Activity fraud score for the affiliate. Applicable only if the "affiliate_fraud_activity" preference is enabled. This should not be manually updated/overridden as the API will update this score automatically. For more information, reference our article on Affiliate Activity Fraud.
fraud_profile_alert_threshold	Nullable Integer	The profile fraud threshold (percent out of 100) at which point an alerts will be generated for this account when changes are made to it. Applicable only if the "affiliate_fraud_profile" preference is enabled. For more information, reference our article on Affiliate Activity Fraud.
fraud_profile_block_threshold	Nullable Integer	The profile fraud threshold (percent out of 100) at which point the account will be automatically blocked (status set to "blocked"). Applicable only if the "affiliate_fraud_profile" preference is enabled. For more information, reference our article on Affiliate Activity Fraud.
fraud_profile_score	Nullable Integer	Profile fraud score for the affiliate. Applicable only if the "affiliate_fraud_profile" preference is enabled. This should not be manually updated/overridden as the API will update this score automatically. For more information, reference our article on Affiliate Activity Fraud.
fraud_risk_tier	Nullable Integer	Fraud risk tier that classifies how likely this affiliate is to be fraudulent. 0: Low, 4: Critical
id	Integer	ID of unique object identifier for the affiliate
method_data	Nullable String	This parameter has been deprecated.
modified	Datetime	The last time this account was updated
other	Nullable String	This parameter has been deprecated.
payment_method	String	The method by which payments are made to the affiliate. The network may restrict which methods are allowed. The payment method indicated by the "affiliate_payment_method_default" Preference.
payment_terms	String	The schedule by which invoices are generated for this affiliate. The terms indicated by the "affiliate_payment_terms_default" preference.
phone	Nullable String	The affiliate's phone number
ref_id	Nullable String	An external reference ID for this account
referral_id	Nullable Integer	The ID of the affiliate account that referred this one
region	Nullable String	The state/province of the account's physical address
signup_ip	Nullable String	The IP address the affiliate used to sign up from
status	String	The status of the account
w9_filed	Boolean	Whether or not a W9 / W8-BEN is on file for this account
wants_alerts	Boolean	This parameter has been deprecated.
website	Nullable String	This parameter has been deprecated.
zipcode	String	The zipcode / postal code of the account's physical address

Show Supported Parameters

user

Object

Affiliate user model object dataShow Supported Parameters

POST Response Notes

Returns the ID of the newly created affiliate as an integer or returns the newly created Affiliate model object if return_object is set to "true"

API Call Builder

Javascript is required to use the API Call Builder.