Difference between revisions of "Offerit REST API Edit Affiliate"

Latest revision as of 11:07, 25 March 2021

PATCH /affiliate/edit_affiliate

Description

• edit_affiliate edits an existing affiliate account

Resource URL

• http://domain/api/affiliate/edit_affiliate
• Replace domain with the Offerit domain

Response Format

• JSON

Request Method

• PATCH

Authentication

• HTTP headers

Parameters

Parameters must be sent with the request body. The examples below show the parameters sent as x-www-form-urlencoded

• loginid
  • type: string
  • required
  • Id of affiliate to edit
• password
  • type: string
  • Affiliate Password
• payvia
  • type: int
  • Payvia type id of the payvia type to use with this affiliate
• email
  • type: string
  • unique
  • Email address for this affiliate
• status
  • type: int
  • ID of the account status for this affiliate (0 - Active, 1 - Disabled, 2 - Banned, 3 - Wait on Verify, 4 - Pending, 5 - Denied)
• firstname
  • type: string
• lastname
  • type: string
• company
  • type: string
• url
  • type: string
• tel
  • type: string
• icq
  • type: string
• aim
  • type: string
• msn
  • type: string
• address1
  • type: string
• address2
  • type: string
• city
  • type: string
• state
  • type: string
• country
  • type: string
• zip_code
  • type: string
• tax_id_or_ssn
  • type: string
• ref
  • type: string
  • Tracking code to identifier who referred this affiliate.
• minimum_payout
  • type: string
  • Threshold for generating affiliate payouts. Affiliate will not be paid until they earn at least this much.
• join_ip
  • type: string
• custom1
  • type: string
  • An additional custom value to store with this affiliate. (255 max)
• custom2
  • type: string
  • An additional custom value to store with this affiliate. (255 max)
• custom3
  • type: string
  • An additional custom value to store with this affiliate. (255 max)
• custom4
  • type: string
  • An additional custom value to store with this affiliate. (255 max)
• custom5
  • type: string
  • An additional custom value to store with this affiliate. (255 max)
• affiliate_manager_loginid
  • type: string
  • loginid of the Affiliate Manager to assign to the affiliate being edited. If a manager is already set for the affiliate, this new manager will be set in addition to the existing one, not replace it.

Example Request

PATCH

http://domain/api/affiliate/edit_affiliate
loginid = 4002
password = apitest
firstname = hello
lastname = test
email = hello@offerit.com
company = Offerit
url = offerit.com
tel = 666-666-6666
icq = 666666666
aim = sixsixsix
msn = sixsixtysix
address1 = 666 666 st
address2 = 
city = My City
state = My State
country = USA
zip_code = 12345

• Response:

[
    {
        "result":"Success","
    }
]

Example Code

PHP

<?php
$curl = curl_init();

$url = 'http://domain/api/affiliate/edit_affiliate';

$headers = array(
    'api-key: 44b5498dbcb481a0d00b404c0169af62',
    'api-username: productsupport'
);

$data = array(
    'loginid' => 4002,
    'password' => 'apitest',
    'firstname' => 'hello',
    'lastname' => 'test',
    'email' => 'hello3@offerit.com',
    'company' => 'Offerit',
    'url' => 'offerit.com',
    'tel' => '666-666-6666',
    'icq' => '666666666',
    'aim' => 'sixsixsix',
    'msn' => 'sixsixtysix',
    'address1' => '666 666 st',
    'address2' => '',
    'city' => 'My City',
    'state' => 'My State',
    'country' => 'USA',
    'zip_code' => '12345',
    'join_ip' => '192.168.1.1',
);

curl_setopt($curl, CURLOPT_HTTPHEADER, $headers); 
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); 
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($data));    

$resp = curl_exec($curl);
//dumps an associative array representation of the json response
$output = json_decode($resp, true);
if($output !== NULL) {
	//json was valid. Dump the decoded array
	print_r($output);
}
else {
	//invalid json, just dump the raw response
	print_r($resp);
}
// Close request to clear up some resources
curl_close($curl);
?>