Affiliate Model

An affiliate account registered with the network. This identifies the company details of the affiliate. An affiliate can have multiple affiliate users each with their own login, associated with this affiliate account.

NameTypeDescription
account_manager_idNullable IntegerThe ID of the employee from the network who is assigned as the account manager for the affiliate
address1Nullable StringThe first line of the account's physical address
address2Nullable StringThe second line of the account's physical address
affiliate_tier_idNullable IntegerThe ID of the affiliate tier to which this affiliate is assigned. If no value is present, the affiliate is in the default tier.
cityNullable StringThe city of the account's physical address
companyStringThe company name of the affiliate
countryNullable StringThe country of the account's physical address
date_addedDatetimeThe date this account was created
faxNullable StringThe fax number of the affiliate
fraud_activity_alert_thresholdNullable IntegerThe 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_thresholdNullable IntegerThe 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_scoreNullable IntegerActivity 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_thresholdNullable IntegerThe 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_thresholdNullable IntegerThe 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_scoreNullable IntegerProfile 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_tierNullable IntegerFraud risk tier that classifies how likely this affiliate is to be fraudulent. 0: Low, 4: Critical
This parameter is non-writable
idIntegerID of unique object identifier for the affiliate
This parameter is non-writable
method_dataNullable String
This parameter has been deprecated.
modifiedDatetimeThe last time this account was updated
otherNullable String
This parameter has been deprecated.
payment_methodStringThe 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.Show Supported Values
payment_termsStringThe schedule by which invoices are generated for this affiliate. The terms indicated by the "affiliate_payment_terms_default" preference.Show Supported Values
phoneNullable StringThe affiliate's phone number
ref_idNullable StringAn external reference ID for this account
referral_idNullable IntegerThe ID of the affiliate account that referred this one
regionNullable StringThe state/province of the account's physical address
signup_ipNullable StringThe IP address the affiliate used to sign up from
statusStringThe status of the accountShow Supported Values
w9_filedBooleanWhether or not a W9 / W8-BEN is on file for this account
wants_alertsBoolean
This parameter has been deprecated.
websiteNullable String
This parameter has been deprecated.
zipcodeStringThe zipcode / postal code of the account's physical address
Have a Question? Please contact [email protected] for technical support.