Opt out
<th>
Description
</th>
<th>
Example
</th>
<th>
More info
</th>
</tr>
<td>
The API area
</td>
<td>
clientcontacts.json
</td>
</tr>
<tr>
<td>
Action
</td>
<td>
The action to perform
</td>
<td>
action=dont\_opt\_in
</td>
</tr>
<tr>
<td>
<General>
</td>
<td>
Parameters described in overview
</td>
<td>
user=user\&password=user\&version=3.3
</td>
<td>
[v3.3 Overview](ref:v30xxx-overview)
</td>
</tr>
<tr>
<td>
Clientcontact
</td>
<td>
Client contact to set inactive
</td>
<td>
clientcontact=8589
</td>
</tr>
<tr>
<td>
Response
</td>
<td>
Returned data
</td>
<td>
A JSON string containing the data
</td>
</tr>
Parameter |
---|
API |
Example request:
Request for data (list of records using specified model)
http://<SERVER>/jsonapi/clients.json?user=user&password=user&version=3.3&action=dont_opt_in&clientcontact=8589
Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"responsemessage": "Client contact(s) opt in changed. ",
"warningmessage": "",
"success": true
}