Update

Update

ParameterMandatoryDescriptionExamplesMore Info
APIYesThe API areasuppliers.json
GeneralYesParameters described in overviewsee overviewStructure of an API call
ActionYesThe action to performaction=update
InputYesJSON stringSee below
JSON InputMandatoryDescriptionExamples
IdentifierYesData to identify record"supplieruuid":"1C740E283C8D2A41B4A1CA7E4964171B"
Update DataYesData to update"supplierCustomField321":"test"

Example request (OAuth 2.0):

Authorization: Bearer <access_token>
http://<SERVER>/jsonapi/suppliers.json?&version=6&action=update&input={
  "data": [
    {
      "supplieruuid": "1C740E283C8D2A41B4A1CA7E4964171B",
      "supplierCustomField321": "test"
    }
  ]
}

Example request (legacy username/password):

http://<SERVER>/jsonapi/suppliers.json?&version=6&action=update&input={
  "data": [
    {
      "supplieruuid": "1C740E283C8D2A41B4A1CA7E4964171B",
      "supplierCustomField321": "test"
    }
  ]
}&user=<username>&password=<password>

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "responsemessage": "data processed successfully.",
  "warningmessage": "",
  "success": true,
  "data": [
    {
      "supplieruuid": "1C740E283C8D2A41B4A1CA7E4964171B",
      "supplierCode": "1/",
      "supplierTimeStampModified": 1540385243,
      "supplierRecordVersionNumber": 2
    }
  ]
}

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