Skip to main content
DELETE
/
api
/
crm
/
cannedresponses
/
{id}
{
  "Status": 123,
  "Message": "<string>",
  "Value": {},
  "WasSuccessful": true,
  "Errors": [
    {}
  ]
}
Deletes a CannedResponse record. Once deleted, the record is permanently removed from the system.
This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.

​
Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the CannedResponse-Delete role.

​
Path Parameters

​
id
integer
required
The Id of the CannedResponse record to delete.

​
Code Examples

curl -X DELETE \
  "https://spaces.nexudus.com/api/crm/cannedresponses/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Response

​
200

​
Status
integer
HTTP status code. 200 on success.
​
Message
string
A human-readable message confirming the deletion.
​
Value
object
Contains the Id of the deleted record.
​
WasSuccessful
boolean
true if the deletion was successful.
​
Errors
array
null on success.
Example Response
{
  "Status": 200,
  "Message": "CannedResponse was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}

​
500

Example Response
{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}