Update

Update an existing client record

ParameterMandatoryDescriptionExamplesMore Info
APIYesThe API areaclients.json
GeneralYesParameters described in overviewuser=user&password=user&version=3.8v3.8 Overview
ActionYesThe action to performaction=update
InputYesJSON stringSee below
JSON InputMandatoryDescriptionExamples
IdentifierYesClient ID or UUID"clientCode":"1/P0909"
Update dataYesData to update"clientName":"NewCompanyInc"

Example request:

http://<SERVER>/jsonapi/clients.json?user=user&password=user&version=3.8&action=update&input={
  "data": [
    {
      "clientCode": "1/P0909",
      "clientName": "NewCompanyInc"
    }
  ]
}

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "responsemessage": "data processed successfully.",
  "warningmessage": "",
  "success": true,
  "data": [
    {
      "clientCode": "1/P0909",
      "clientUuid": "493686EA86774194831FFE438B031917",
      "clientTimeStampModified": 1544093783,
      "clientRecordVersionNumber": 97
    }
  ]
}

Note:

To discover which fields are editable make a call to the "Client details" endpoint and specify '&style=modelstructure' see Meta-data