Update a client contact record
Update
Parameter | Description | Example | More info |
---|---|---|---|
API | The API area | clientcontacts.json | |
Action | The action to perform | action=update | |
Parameters described in overview | user=user&password=user | ||
input | Client contact Internal Ref (mandatory), then name/value pairs | "data": [<see example>] | |
Response | Returned data | See below |
Response|Returned data|See below
Example request:
http://<SERVER>/jsonapi/clientcontacts.json?user=user&password=user&version=3.3&action=update&input={
"data": [
{
"clientcontactInternalRef": 6535,
"clientcontactFirstName": "Babs",
"clientcontactName": "Smith"
}
]
}
Updating a custom field...
http://<SERVER>/jsonapi/clientcontacts.json?user=user&password=user&version=3.3&action=update&input={
"data": [
{
"clientcontactInternalRef": 6535,
"clientcontactCustomField200": "text1a"
}
]
}
Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"responsemessage": "data processed successfully.",
"warningmessage": "",
"success": true,
"data": [
{
"clientcontactInternalRef": 6535,
"clientcontactuuid": "05F73F03055D4F0D942A7E03D0BA09EE",
"clientcontactTimeStampModified": 1544094783,
"clientcontactRecordVersionNumber": 11
}
]
}
Note:
To discover which fields are editable make a call to the "Contacts details" endpoint and specify '&style=modelstructure' see Meta-data