Delete

Delete

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=delete
InputYesJSON stringSee below
JSON InputMandatoryDescriptionExamples
IdentifierYesClient ID or UUID"clientCode":"1/P0909"

Example request (OAuth 2.0):

Authorization: Bearer <access_token>
http://<SERVER>/jsonapi/clients.json?&version=6&action=delete&input={
  "data": [
    {
      "clientCode": "1/P0909"
    }
  ]
}

Example request (legacy username/password):

http://<SERVER>/jsonapi/clients.json?&version=6&action=delete&input={
  "data": [
    {
      "clientCode": "1/P0909"
    }
  ]
}&user=<username>&password=<password>

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "responsemessage": "data processed successfully.",
  "warningmessage": "",
  "success": true,
  "data": [
    {
      "clientCode": "1/P2028",
      "clientUuid": "6BDD26C48BF1D445B4EF8CEDCEFDD685"
    }
  ]
}