Submit a Ticket My Tickets
Welcome
Login  Sign up

[Addedit] Affiliate (V2) - Admin

WSDL Page:  http://<your_domain_here>/api/2/addedit.asmx?op=Affiliate

Parameter Summary:

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

affiliate_id / INT = Affiliate ID  ["0" Create new affiliate /  "ID" Update affiliate]

affiliate_name / STRING = Affiliate Name

third_party_name / STRING = 3rd Party Name of Affiliate

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

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]

tags / STRING = Tag IDs [can be comma-separated] {See get.asmx > AffiliateTags} [Pass "NULL" to not update this field]

pixel_html / STRING = The HTML pixel that will be used for the Affiliate global pixel [Leaving this field blank will not update an existing pixel_html]

postback_url / STRING = The URL that will be used for the Affiliate global postback URL [Leaving this field blank will not update an existing postback_url]

postback_delay_ms / STRING = Amount of time( in MS) the postback URL will wait before its fired.

fire_global_pixel / BOOL = Fire the global pixel?

date_added / DATETIME = Date Added [MM/DD/YYYY HH:MM:SS]

online_signup / BOOL = Online Signup

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 - BOOL

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

media_type_ids - ASSIGNABLE

price_format_ids - ASSIGNABLE

vertical_category_ids - ASSIGNABLE

country_codes - ASSIGNABLE

tags - ASSIGNABLE

pixel_html - ASSIGNABLE

postback_URL - ASSIGNABLE

postback_delay_ms - ASSIGNABLE

fire_global_pixel - ASSIGNABLE

date_added - ASSIGNABLE

online_signup - BOOL

signup_ip_address - ASSIGNABLE

referral_affiliate_id - ASSIGNABLE

referral_notes - ASSIGNABLE

terms_and_conditions_agreed - BOOL

notes - ASSIGNABLE

 

Sample GET Call:

 http://demo.cakemarketing.com/api/2/addedit.asmx/Affiliate?api_key=dNJFmId9rI&affiliate_id=0&affiliate_name=Affiliate+Name+Here&third_party_name=brad123&account_status_id=1&inactive_reason_id=0&affiliate_tier_id=0&account_manager_id=3505&hide_offers=FALSE&website=http%3A%2F%2Fbradsexample.com&tax_class=Corporation&ssn_tax_id=123456789&vat_tax_required=FALSE&swift_iban=12321321&payment_to=0&payment_fee=0&payment_min_threshold=1500&currency_id=1&payment_setting_id=1&billing_cycle_id=2&payment_type_id=4&payment_type_info=Here+is+some+payment+information+that+willl+allow+me+to+get+paid&address_street=123+Main+Street&address_street2=suite+250&address_city=Fullerton&address_state=CA&address_zip_code=92831&address_country=US&media_type_ids=13%2C8&price_format_ids=1%2C2%2C3&vertical_category_ids=11%2C6%2C12&country_codes=US%2CCA&tags=NULL&pixel_html=%3Ciframe+src%3D%22http%3A%2F%2Fdemotrk.cakemarketing.com%2Fp.ashx%3Fo%3D197%26t%3DTRANSACTION_ID%22+height%3D%221%22+width%3D%221%22+frameborder%3D%220%22%3E%3C%2Fiframe%3E&postback_url=&postback_delay_ms=0&fire_global_pixel=False&date_added=10%2F24%2F2006&online_signup=FALSE&signup_ip_address=&referral_affiliate_id=0&referral_notes=0&terms_and_conditions_agreed=TRUE&notes=Specialize+in+CPC+traffic

 

Sample XML Response:

<?xml version="1.0" encoding="utf-8"?>
<affiliate_addedit_response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://cakemarketing.com/api/2/">
  <success>true</success>
  <message>Affiliate 1111318 Created</message>
  <affiliate_id>1111318</affiliate_id>
</affiliate_addedit_response>

 

Did you find it helpful? Yes No

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