SIGNUP Affiliate API Version 3 (DEPRECATED)

Ron Torres

Modified on: Thu, 19 Nov, 2015 at 6:11 PM

SIGNUP Affiliate API VERSION 3

Updated on 2014-06-02
Current Version: Version 3
Deprecated Version: V1, V2
Requests Allowed: GET&SOAP

Summary:

Returns Message: "Affiliate Added Successfully"

Resource/WSDL Page:

http://<your_domain_here>/api/3/signup.asmx?op=Affiliate

Parameters

api_key Required Type: STRING Length (Max/Min): 50	Must be a valid API key (existing and NOT expired) Example Values: Fo35NRAqvFLXoZxqB4aViaiYM7iVMhh
affiliate_name Required Type: STRING Length (Max/Min): 50	Affiliate Name Example Values: Affiliate Name
account_status_id Required Type: BYTE Length (Max/Min): NA	Affiliate Account Status ID. Must be 1-3. Example Values: 1
affiliate_tier_id Required Type: BYTE Length (Max/Min): NA	Affiliate Tier ID. 0 to skip Example Values: 1
hide_offers Required Type: BOOL Length (Max/Min): NA	Hide Offers with no Campaigns in the Affiliate Portal? ["TRUE", "FALSE"] Example Values: True
website Required Type: STRING Length (Max/Min): 100	Affiliate Website Example Values: www.affiliatewebsite.com
tax_class Required Type: STRING Length (Max/Min): 30	Tax Class ["Corporation", "Individual/Sole Proprietor", "Partners/LLC/LLP", "Other"] Example Values: Corporation
ssn_tax_id Required Type: STRING Length (Max/Min): 20	SSN or Tax ID Example Values: 123456789
vat_tax_required Required Type: BOOL Length (Max/Min): NA	VAT Tax Required? ["TRUE", "FALSE"] Example Values: True
swift_iban Required Type: STRING Length (Max/Min): NA	SWIFT/IBAN ID. Not used if tipalti is enabled Example Values: 123456
payment_to Required Type: BYTE Length (Max/Min): NA	Payment Entity ["0" = Company Name, "1" = Main Contact]. Not used if tipalti is enabled Example Values: 0
payment_fee Required Type: DECIMAL Length (Max/Min): NA	Payment Fee. < 0 to skip Example Values: 20.05
payment_min_threshold Required Type: DECIMAL Length (Max/Min): NA	Minimum payment threshold. < 0 to use the global setting Example Values: 20.05
currency_id Required Type: BYTE Length (Max/Min): NA	Payout Currency ID {See get.asmx > Currencies}. 0 to skip, used only for currency enabled clients. Max value is 255, no negative values accepted. Example Values: 1
payment_setting_id Required Type: BYTE Length (Max/Min): NA	Affiliate Payout Settings {See get.asmx > PaymentSettings}. 0 to skip. Max value is 255, no negative values accepted. Example Values: 1
billing_cycle_id Required Type: BYTE Length (Max/Min): NA	Billing Cycle ID {See get.asmx > BillingCycles}. 0 to skip. Max value is 255, no negative values accepted. Example Values: 0
payment_type_id Required Type: BYTE Length (Max/Min): NA	Payment Type ID {See get.asmx > PaymentTypes}. If tipalti is enabled it uses tipalti else 0 to skip. Max value is 255, no negative values accepted. Example Values: 1
payment_type_info Required Type: STRING Length (Max/Min): 100	Payment Details. Not used if tipalti is enabled Example Values: 45
address_street Required Type: STRING Length (Max/Min): 60	Only used if all address fields are non-NULL and non-empty Example Values: 123 Pacific Coast Highway
address_street2 Required Type: STRING Length (Max/Min): 60	Only used if all address fields are non-NULL and non-empty Example Values: Macarthur
address_city Required Type: STRING Length (Max/Min): 30	Only used if all address fields are non-NULL and non-empty Example Values: Newport Beach
address_state Required Type: STRING Length (Max/Min): 20	Only used if all address fields are non-NULL and non-empty Example Values: California
address_zip_code Required Type: STRING Length (Max/Min): 10	Only used if all address fields are non-NULL and non-empty Example Values: 92660
address_country Required Type: STRING Length (Max/Min): 30	Only used if all address fields are non-NULL and non-empty Example Values: United States
contact_first_name Required Type: STRING Length (Max/Min): 25	Only used if all contact fields are non-NULL and non-empty Example Values: Bob
contact_middle_name Required Type: STRING Length (Max/Min): 25	Only used if all contact fields are non-NULL and non-empty Example Values: William
contact_last_name Required Type: STRING Length (Max/Min): 25	Only used if all contact fields are non-NULL and non-empty Example Values: Smith
contact_email_address Required Type: STRING Length (Max/Min): 60	Only used if all contact fields are non-NULL and non-empty Example Values: bobwsmith@email.com
contact_password Required Type: STRING Length (Max/Min): 25	Please note: Due to recent security updates, affiliates can only set their password via the CAKE reset password functionality. CAKE recommends not including this field on your form and passing a dummy value since the affiliate will need to set their own password once approved. Example Values:** abc123
contact_title Required Type: STRING Length (Max/Min): 30	Only used if all contact fields are non-NULL and non-empty Example Values: President
contact_phone_work Required Type: STRING Length (Max/Min): 30	Only used if all contact fields are non-NULL and non-empty Example Values: 212-555-1212
contact_phone_cell Required Type: STRING Length (Max/Min): 30	Only used if all contact fields are non-NULL and non-empty Example Values: 212-555-1212
contact_phone_fax Required Type: STRING Length (Max/Min): 30	Only used if all contact fields are non-NULL and non-empty Example Values: 212-555-1212
contact_im_service Required Type: STRING Length (Max/Min): 50	Only used if all contact fields are non-NULL and non-empty Example Values: AIM
contact_im_name Required Type: STRING Length (Max/Min): 30	Only used if all contact fields are non-NULL and non-empty Example Values: bobwsmith
contact_timezone Required Type: STRING Length (Max/Min): 4	Only used if all contact fields are non-NULL and non-empty Example Values: EST
contact_language_id Required Type: BYTE Length (Max/Min): 30	Max value is 255, no negative values accepted. Example Values: 1
media_type_ids Required Type: STRING Length (Max/Min): NA	Media Type IDs [can be comma-separated] {See get.asmx > GetMediaTypes} Example Values: media type
price_format_ids Required Type: STRING Length (Max/Min): NA	Price Format IDs [can be comma-separated] {See get.asmx > GetPriceFormats} Example Values: price format
vertical_category_ids Required Type: STRING Length (Max/Min): NA	Vertical Category IDs [can be comma-separated] {See get.asmx > GetVerticalCategories} Example Values: vertical category
country_codes Required Type: STRING Length (Max/Min): NA	This should be a comma separated list of country codes Example Values:
tag_ids Required Type: STRING Length (Max/Min): NA	This should be a comma separated list of tag names, each tag name cannot exceed 50 characters Example Values:
date_added Required Type: DATETIME Length (Max/Min): NA	Date added [MM/DD/YYYY HH:MM:SS] Example Values: 04/28/2014 12:30:09
signup_ip_address Required Type: STRING Length (Max/Min): 15	Required if online_signup is true Example Values: 12.34.567.89
referral_affiliate_id Required Type: INT Length (max/Min): NA	0 to skip on edit Example Values: 1234
referral_notes Required Type: STRING Length (Max/Min): 50	Used on creation, NULL or empty skips on edit Example Values: Referral Notes
notes Required Type: STRING Length (Max/Min): NA	Freeform notes. Used on creation, NULL or empty skips on edit Example Values: Notes

**Note all optional parameters still need to be passed through in the actual call. These parameters do not need a value (therefore you can use a null value).

Example Request

GET

https://demo.cakemarketing.com/api/3/signup.asmx/Affiliate?api_key=dNJFmId9rI&affiliate_name=CPAAPI&account_status_id=1&affiliate_tier_id=1&hide_offers=FALSE&website=http://getCAKE.com&tax_class=Other&ssn_tax_id=565579584&vat_tax_required=FALSE&swift_iban=1234567890&payment_to=1&payment_fee=3.00&payment_min_threshold=15.00&currency_id=1&payment_setting_id=1&billing_cycle_id=1&payment_type_id=1&payment_type_info=ROUTINGNUMBER+46236346&address_street=2244+West+Coast+Highway&address_street2=STE+250&address_city=Newport+Beach&address_state=CA&address_zip_code=92663&address_country=US&contact_first_name=Andy&contact_middle_name=CAKE&contact_last_name=Worford&contact_email_address=andy123456@getCAKE.com&contact_password=a069gsSDG9&contact_title=Head+of+QA&contact_phone_work=9495482253+x204&contact_phone_cell=9493512600&contact_phone_fax=9495152010&contact_im_service=1&contact_im_name=cake_andy&contact_timezone=PST&contact_language_id=1&media_type_ids=15,7,6&price_format_ids=1,2,4&vertical_category_ids=1,2,20&country_codes=US,CA,AF&tag_ids=1,3,4&date_added=08/08/2012&signup_ip_address=8.8.8.8&referral_affiliate_id=4401&referral_notes=Great+referral+here&notes=Here+is+where+I%27m+putting+my+notes

Sample XML Response:

<affiliate_signup_response>
<success>true</success>
<message>Affiliate Added Successfully</message>
<affiliate_id>6105</affiliate_id>
</affiliate_signup_response>

Example Error Messages:

Error Message	Likely Cause
Invalid API Key	API key does not exist or is expired
Missing Fields	Returns the name of the fields that are missing input.
Fields Exceed Max Input Length	Returns the list of the fields that exceed the maximum characters allowed.
Invalid Email Address	Email address is invalid or already exists.
Duplicate Affiliate Contact	Affiliate already exists.