Parameter | Mandatory | Description | Examples | More Info |
---|---|---|---|---|
API | Yes | The API area | clientcontacts.json | |
General | Yes | Parameters described in overview | user=user&password=user&version=3.9 | Overview |
Action | Yes | The action to perform | action=delete | |
Input | Yes | JSON string | See below |
JSON Input | Mandatory | Description | Examples |
---|---|---|---|
Identifier | Yes | Contact ID or UUID | "clientcontactInternalRef":6535 |
Example request:
http://<SERVER>/jsonapi/clientcontacts.json?user=user&password=user&version=3.9&action=delete&input={
"data": [
{
"clientcontactInternalRef": 6535
}
]
}
Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"responsemessage": "data processed successfully.",
"warningmessage": "",
"success": true,
"data": [
{
"clientcontactInternalRef": 8635,
"clientcontactuuid": "18220E9DA4761141891ED2C5E55838CF"
}
]
}