Difference between revisions of "NATS4 REST API Set Affiliate Status"
From TMM Wiki
Jump to navigationJump to search (Created page with "{{NATS4 Manual | show_api_admin_section = true }} == '''PATCH /affiliate/status''' == '''Description''' *The /affiliate/status action is a feature in NATS4 that allows y...") |
|||
| Line 39: | Line 39: | ||
**optional | **optional | ||
| − | *approve_deny: | + | *approve_deny: Set to one if you are using the API to approve or deny affiliates. This causes the EMAIL_AFFILIATE_ON_APPROVE email to be sent instead of the EMAIL_AFFILIATE_ON_ENABLED |
**'''''type: integer''''' | **'''''type: integer''''' | ||
**optional | **optional | ||
Revision as of 17:02, 10 June 2019
PATCH /affiliate/status
Description
- The /affiliate/status action is a feature in NATS4 that allows you to set the affiliate status settings
Resource URL
- http://domain/api/affiliate/status
- Replace domain with the nats domain
- PATCH
Response Format
- JSON
- HTTP headers
Parameters
Paremeters must be sent with the request body. The examples below show the parameters sent as x-www-form-urlencoded
- loginid: is the affiliates loginid
- type: integer
- required
- status: desired account status 0=Active, 1=Disabled, 2=Banned, 3=Wait on Verify, 4=Pending, 5=Denied
- type: integer
- required
- internal_reason: is the internal reason for this affiliate's status.
- type: string
- optional
- public_reason: is the public reason for this affiliate's status.
- type: string
- optional
- approve_deny: Set to one if you are using the API to approve or deny affiliates. This causes the EMAIL_AFFILIATE_ON_APPROVE email to be sent instead of the EMAIL_AFFILIATE_ON_ENABLED
- type: integer
- optional
Example Request
PATCH
http://domain/api/affiliate/status
- Response:
[
{
"result":"true"
}
]
Example Code
PHP
<?php
$curl = curl_init();
$data = array(
'loginid' => '1',
'status' => '0',
'internal_reason' => 'internal reason',
'public_reason' => 'public reason',
);
$url = 'http://domain/api/affiliate/status';
$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: tmm1phrvezsbu'
);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($data));
curl_setopt($curl, CURLOPT_URL, $url);
$resp = curl_exec($curl);
//makes an associative array representation of the json
$result = json_decode($resp, true);
//prints associative array representation of json result
var_dump($result);
// Close request to clear up some resources
curl_close($curl);
?>
