Update

Update an existing client record

Update

Parameter

Description

Example

More info

API

The API area

clients.json

Action

The action to perform

action=update

General

Parameters described in overview

user=user&password=user&version=3.3

v3.3 Overview

input

Pass client code, then name/value pairs

"data": [<see example>]

input

Client code (mandatory), then name/value pairs

"data": [<see example>]

Response

Returned data

See below

Example requests:

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

*Updating a custom field*
http://<SERVER>/jsonapi/clients.json?user=user&password=user&version=3.3&action=update&input={
  "data": [
    {
      "clientCode": "1/P0909",
      "clientCustomField196": "a longer item to select"
    }
  ]
}

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