Active Off

Active Off

ParameterMandatoryDescriptionExamplesMore Info
APIYesThe API areaclients.json
GeneralYesParameters described in overviewAuthorization: Bearer <access_token> header — see Synergist API AuthenticationStructure of an API call
ActionYesThe action to performaction=active_off
IdentifierYesClient ID or UUIDclient=1/P0909

Example request (OAuth 2.0):

Authorization: Bearer <access_token>
http://&lt;SERVER&gt;/jsonapi/clients.json?&version=6&action=active_off&client=1/P0909

Example request (legacy username/password):

http://&lt;SERVER&gt;/jsonapi/clients.json?&version=6&action=active_off&client=1/P0909&user=<username>&password=<password>

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "responsemessage": "Organisation active flag changed. ",
  "warningmessage": "",
  "success": true
}