Opt Out (GDPR)

ParameterMandatoryDescriptionExamplesMore Info
APIYesThe API areaclientcontacts.json
GeneralYesParameters described in overviewuser=user&password=user&version=3.9Overview
ActionYesThe action to performaction=dont_opt_in
IdentifierYesContact ID or UUIDclientcontact=8589

Example request:

http://<SERVER>/jsonapi/clients.json?user=user&password=user&version=3.9&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
}