Create a client contact record
Create
| Parameter | Mandatory | Description | Examples | More Info |
|---|---|---|---|---|
| API | Yes | The API area | clientcontacts.json | |
| General | Yes | Parameters described in overview | Authorization: Bearer <access_token> header — see Synergist API Authentication | Structure of an API call |
| Action | Yes | The action to perform | action=create | |
| Input | Yes | JSON string | See below |
| JSON Input | Mandatory | Description | Examples |
|---|---|---|---|
| clientcontactClientCode | Yes | Client code | "clientcontactClientCode":"1/2365" |
| clientcontactFirstName | Yes | First name | "clientcontactFirstName":"James" |
Example request (OAuth 2.0):
Authorization: Bearer <access_token>
http://<SERVER>/jsonapi/clientcontacts.json?&version=6&action=create&input={
"data": [
{
"clientcontactClientCode": "1/2365",
"clientcontactFirstName": "James"
}
]
}
Example request (legacy username/password):
http://<SERVER>/jsonapi/clientcontacts.json?&version=6&action=create&input={
"data": [
{
"clientcontactClientCode": "1/2365",
"clientcontactFirstName": "James"
}
]
}&user=<username>&password=<password>
Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"responsemessage": "data processed successfully.",
"warningmessage": "",
"success": true,
"data": [
{
"clientcontactuuid": "4DBB03C727768C4791377A628866A114",
"clientcontactInternalRef": 8628,
"clientcontactTimeStampModified": 1532615972,
"clientcontactRecordVersionNumber": 0
}
]
}