Offerit REST API Edit Affiliate - Revision history

Offeritnick: /* Parameters */

2021-03-25T16:07:48Z

‎Parameters

Offeritnick: /* Parameters */

2017-11-06T21:14:28Z

‎Parameters

OfferitRob: /* Parameters */

2017-10-30T19:51:22Z

‎Parameters

OfferitRob: /* Parameters */

2017-10-03T14:55:37Z

‎Parameters

Offeritnick: /* Parameters */

2017-07-28T18:35:09Z

‎Parameters

Offeritnick: /* Parameters */

2017-07-28T18:27:59Z

‎Parameters

Offeritnick: /* Parameters */

2017-07-28T18:25:41Z

‎Parameters

Offeritnick at 21:23, 12 May 2017

2017-05-12T21:23:11Z

Offeritnick: Created page with "{{Offerit Manual | show_rest_api_section = true }} == '''PATCH /affiliate/edit_affiliate ''' == '''Description''' *edit_affiliate edits an existing affiliate account ''..."

2017-05-12T00:14:05Z

Created page with "{{Offerit Manual | show_rest_api_section = true }} == '''PATCH /affiliate/edit_affiliate ''' == '''Description''' *edit_affiliate edits an existing affiliate account ''..."

New page

{{Offerit Manual
| show_rest_api_section = true
}}
== '''PATCH /affiliate/edit_affiliate ''' ==
'''Description'''
*edit_affiliate edits an existing affiliate account

'''Resource URL'''
*<nowiki>http://domain/api/affiliate/edit_affiliate</nowiki>
*Replace domain with the Offerit domain

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*PATCH

'''[[Offerit_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==

'''''Paremeters 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'''''
**'''''required'''''
**Affiliate Password
*payvia
**'''''type: int'''''
**'''''required'''''
**Payvia type id of the payvia type to use with this affiliate
*email
**'''''type: string'''''
**'''''required'''''
**'''''unique'''''
**Email address for this affiliate
*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'''''

== '''Example Request''' ==

'''PATCH'''
<pre>
<nowiki>
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

</nowiki>
</pre>
*Response:
<pre>
[
{
"result":"Success","
}
]
</pre>

== '''Example Code''' ==

'''PHP'''
<pre>
<?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
var_dump(json_decode($resp, true));
// Close request to clear up some resources
curl_close($curl);
?>

</pre>

[[Category:Offerit API Articles]]

@@ Line 90: / Line 90: @@
 **'''''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''' ==

@@ Line 81: / Line 81: @@
 *affiliate_manager_loginid
 **'''''type: string'''''
-**loginid of the Affiliate Manager to assign to the affiliate being edited
+**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.
 -->

@@ Line 79: / Line 79: @@
 **'''''type: string'''''
 <!-- Waiting on OF-314 to be released
-*affiliate_manager_id
+*affiliate_manager_loginid
 **'''''type: string'''''
-**You can pass an affiliate manager's loginid to set them as the manager for the affiliate being edited
+**loginid of the Affiliate Manager to assign to the affiliate being edited
 -->

@@ Line 37: / Line 37: @@
 **'''''unique'''''
 **Email address for this affiliate
 *firstname
 **'''''type: string'''''

@@ Line 29: / Line 29: @@
 *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

@@ Line 22: / Line 22: @@
 == '''Parameters''' ==
-'''''Paremeters must be sent with the request body. The examples below show the parameters sent as x-www-form-urlencoded'''
+'''''Parameters must be sent with the request body. The examples below show the parameters sent as x-www-form-urlencoded'''
 *loginid
 **'''''type: string'''''
@@ Line 78: / Line 78: @@
 *join_ip
 **'''''type: string'''''
 <!-- Waiting on OF-314 to be released
 *affiliate_manager_loginid

@@ Line 158: / Line 158: @@
 $resp = curl_exec($curl);
-//dumps an associative array representation of the json
+//dumps an associative array representation of the json response
-var_dump(json_decode($resp, true));
+$output = json_decode($resp, true);
 // Close request to clear up some resources
 curl_close($curl);