Opt Out (GDPR)

Parameter	Mandatory	Description	Examples	More Info
API	Yes	The API area	clientcontacts.json
General	Yes	Parameters described in overview	`Authorization: Bearer <access_token>` header — see Synergist API Authentication	Structure of an API call
Action	Yes	The action to perform	action=dont_opt_in
Identifier	Yes	Contact ID or UUID	clientcontact=8589

Example request (OAuth 2.0):

Authorization: Bearer <access_token>
http://&lt;SERVER&gt;/jsonapi/clientcontacts.json?&version=6&action=dont_opt_in&clientcontact=8589

Example request (legacy username/password):

http://&lt;SERVER&gt;/jsonapi/clientcontacts.json?&version=6&action=dont_opt_in&clientcontact=8589&user=<username>&password=<password>

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "responsemessage": "Organisation contact(s) opt in changed. ",
  "warningmessage": "",
  "success": true
}