Submit a Ticket My Tickets
Welcome
Login  Sign up

[Signup] Affiliate (V4) - Admin

WSDL Page:  http://<your_domain_here>/api/4/signup.asmx?op=Affiliate

 

Parameter Summary:

api_key / STRING = Admin API Key {See get.asmx > GetAPIKey}

affiliate_name / STRING = Affiliate Name

account_status_id / INT (unsignedByte) = Affiliate Account Status ID {See get.asmx > AccountStatuses}

affiliate_tier_id / INT (unsignedByte) = Affiliate Tier ID {See get.asmx > AffiliateTiers}

hide_offers / BOOL = Hide Offers with no Campaigns in the Affiliate Portal? ["TRUE", "FALSE"]

website / STRING = Affiliate Website

tax_class / STRING = Tax Class ["Corporation", "Individual/Sole Proprietor", "Partners/LLC/LLP", "Other"]

ssn_tax_id / STRING = SSN or Tax ID

vat_tax_required / BOOL = VAT Tax Required? ["TRUE", "FALSE"]

swift_iban / STRING = SWIFT/IBAN ID

payment_to / INT (unsignedByte) = Payment Entity ["0" = Company Name, "1" = Main Contact]

payment_fee / DECIMAL = Payment Fee

payment_min_threshold / DECIMAL = Minimum Payment Threshold

currency_id / INT (unsignedByte) = Payout Currency ID {See get.asmx > Currencies}

payment_setting_id / INT (unsignedByte) = Affiliate Payout Settings {See get.asmx > PaymentSettings}

billing_cycle_id / INT (unsignedByte) = Billing Cycle ID {See get.asmx > BillingCycles}

payment_type_id / INT (unsignedByte) = Payment Type ID {See get.asmx > PaymentTypes}

payment_type_info / STRING = Payment Details

address_street / STRING = Street Address 1

address_street2 / STRING = Street Address 2

address_city / STRING = City

address_state / STRING = State

address_zip_code / STRING = Zip Code

address_country / STRING = Country

contact_first_name / STRING = Contact First Name

contact_middle_name / STRING = Contact Middle Name

contact_last_name / STRING = Contact Last Name

contact_email_address / STRING = Contact Email Address

contact_password / STRING = Contact Password

contact_title / STRING = Contact Title

contact_phone_work / STRING = Contact Work Phone

contact_phone_cell / STRING = Contact Cell Phone

contact_phone_fax / STRING = Contact Fax

contact_im_service / INT = Contact IM Service ["0" = AIM, "1" = Google, "2" = MSN, "3" = Skype, "4" = Yahoo, "-1"= Ignore IM Contact Service]

contact_im_name / STRING = Contact IM Name

contact_timezone / STRING = Contact Timezone

contact_language_id / INT (unsignedByte) = Contact Language ID {See get.asmx > Languages}

media_type_ids / STRING = Media Type IDs [can be comma-separated] {See get.asmx > GetMediaTypes}

price_format_ids / STRING = Price Format IDs [can be comma-separated] {See get.asmx > GetPriceFormats}

vertical_category_ids / STRING = Vertical Category IDs [can be comma-separated] {See get.asmx > GetVerticalCategories}

country_codes / STRING = Country Codes [can be comma-separated]

tag_ids / STRING = Tag IDs [can be comma-separated] {See get.asmx > AffiliateTags}

date_added / DATE = Date Added [MM/DD/YYYY]

signup_ip_address / STRING = Signup IP Address

referral_affiliate_id / INT = Referral Affiliate ID {See export.asmx > Affiliates}

referral_notes / STRING = Referral Notes

terms_and_conditions_agreed / BOOL = Agreed to the Terms and Conditions? ["TRUE", "FALSE"]

notes / STRING = Freeform Notes

 

Parameter Types:

api_key - ID

affiliate_name - ASSIGNABLE

account_status_id - ASSIGNABLE

affiliate_tier_id - ASSIGNABLE

hide_offers - ASSIGNABLE

website - ASSIGNABLE

tax_class - ASSIGNABLE

ssn_tax_id - ASSIGNABLE

vat_tax_required - ASSIGNABLE

swift_iban - ASSIGNABLE

payment_to - ASSIGNABLE

payment_fee - ASSIGNABLE

payment_min_threshold - ASSIGNABLE

currency_id - ASSIGNABLE

payment_setting_id - ASSIGNABLE

billing_cycle_id - ASSIGNABLE

payment_type_id - ASSIGNABLE

payment_type_info - ASSIGNABLE

address_street - ASSIGNABLE

address_street2 - ASSIGNABLE

address_city - ASSIGNABLE

address_state - ASSIGNABLE

address_zip_code - ASSIGNABLE

address_country - ASSIGNABLE

contact_first_name - ASSIGNABLE

contact_middle_name - ASSIGNABLE

contact_last_name - ASSIGNABLE

contact_email_address - ASSIGNABLE

contact_password - ASSIGNABLE

contact_title - ASSIGNABLE

contact_phone_work - ASSIGNABLE

contact_phone_cell - ASSIGNABLE

contact_phone_fax - ASSIGNABLE

contact_im_service - ASSIGNABLE

contact_im_name - ASSIGNABLE

contact_timezone - ASSIGNABLE

contact_language_id - ASSIGNABLE

media_type_ids - ASSIGNABLE

price_format_ids - ASSIGNABLE

vertical_category_ids - ASSIGNABLE

country_codes - ASSIGNABLE

tag_ids - ASSIGNABLE

date_added - ASSIGNABLE

signup_ip_address - ASSIGNABLE

referral_affiliate_id - ASSIGNABLE

referral_notes - ASSIGNABLE

terms_and_conditions_agreed - ASSIGNABLE

notes - ASSIGNABLE

 

Sample GET Call:

https://demo.cakemarketing.com/api/4/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=andy123@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&terms_and_conditions_agreed=TRUE&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>6104</affiliate_id>
  <tipalti_iframe_expiration_date xsi:nil="true"/>
</affiliate_signup_response>

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.