Create

Create a client record

Create

Parameter

Description

Example

More info

API

The API area

clients.json

Action

The action to perform

action=create

Parameters described in overview

user=user&password=user

v3.3 Overview

input

Client category (mandatory), client code (optional), then name/value pairs

"data":

[<see example>]

Response

Returned data

See below

Note

  1. Client category: Client=3, Prospect=2
  2. Leads are not currently supported
  3. clientCode is only required if your system is set up to use 'Own client/prospect account numbers'

Example request:

http://<SERVER>/jsonapi/clients.json?user=user&password=user&version=3.3&action=create&input={
  "data": [
    {
      "clientCategory": 3,
      "clientCode": "1/BLOGG1",
      "clientname": "Bloggs Ltd",
      "clientCompanyNumber": 1
    }
  ]
}

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "responsemessage": "data processed successfully.",
  "warningmessage": "",
  "success": true,
  "data": [
    {
      "clientUuid": "AC80A6A24CB212439157C8DFD4F9AC5A",
      "clientCode": "1/P2027",
      "clientTimeStampModified": 1532593065,
      "clientRecordVersionNumber": 0
    }
  ]
}