Delete

Delete

ParameterMandatoryDescriptionExamplesMore Info
APIYesThe API areaclientcontacts.json
GeneralYesParameters described in overviewAuthorization: Bearer <access_token> header — see Synergist API AuthenticationStructure of an API call
ActionYesThe action to performaction=delete
InputYesJSON stringSee below
JSON InputMandatoryDescriptionExamples
IdentifierYesContact ID or UUID"clientcontactInternalRef":6535

Example request (OAuth 2.0):

Authorization: Bearer <access_token>
http://<SERVER>/jsonapi/clientcontacts.json?&version=6&action=delete&input={
  "data": [
    {
      "clientcontactInternalRef": 6535
    }
  ]
}

Example request (legacy username/password):

http://<SERVER>/jsonapi/clientcontacts.json?&version=6&action=delete&input={
  "data": [
    {
      "clientcontactInternalRef": 6535
    }
  ]
}&user=<username>&password=<password>

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "responsemessage": "data processed successfully.",
  "warningmessage": "",
  "success": true,
  "data": [
    {
      "clientcontactInternalRef": 8635,
      "clientcontactuuid": "18220E9DA4761141891ED2C5E55838CF"
    }
  ]
}