Sirportly

Toggle Menu

Delete a contact

This method will delete a contact from your database.

URL

/api/v2/contacts/delete

Parameters

  • contact - this is the name, ID or reference for a contact (required)

Returned Data

If the contact is removed, you will receive a 200 OK status whereas, if the contact cannot be removed (i.e. they have assigned tickets) you will receive a 409 Conflict

Example JSON

Example of a successful deletion:

{
  "status": "deleted"
}

Example of a failed deletion:

{
  "status": "restricted",
  "message": "Cannot delete record because of dependent tickets"
}

Example if a contact was not found:

{
  "error": "Customer not found with reference, name or ID exclusively matching 'SS2'"
}