Delete client

DELETE /api/v2/clients/{ClientGUID}

Bearer auth

Delete a client record.

Path parameters

ClientGUID string(uuid) Required

The GUID of the client to delete.

Responses

200 application/json

Success
Hide response attributes Show response attributes object
- success boolean
  
  Default value is true.
- message string
403 application/json

Permission error.
Hide response attributes Show response attributes object
- success boolean
  
  Default value is false.
- message string
404 application/json

Client not found.
Hide response attributes Show response attributes object
- success boolean
  
  Default value is false.
- message string
409 application/json

Unable to delete client due to status of linked clients.
Hide response attributes Show response attributes object
- success boolean
  
  Default value is false.
- message string
- data array[string]

DELETE /api/v2/clients/{ClientGUID}

curl \
 -X DELETE https://api.fincalc.co.uk/api/v2/clients/{ClientGUID} \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "success": true,
  "message": "Client deleted successfully"
}

Response examples (403)

{
  "success": false,
  "message": "You do not have permission to delete that client."
}

Response examples (404)

{
  "success": false,
  "message": "Client not found."
}

Response examples (409)

{
  "success": false,
  "message": "Cannot delete client due to relationship issues.",
  "data": [
    "Ben Amos cannot be deleted as has a financial relationship with Carrie Amos, who does not have a relationship to del test."
  ]
}