delete_canned_reply

Purpose

Take a snippet out of the picker for good. Messages that were sent using it are ordinary messages on their threads and are not affected — a snippet is a template, not a link.

Emits support.canned_reply.deleted with a snapshot of the snippet taken before it went. Idempotent in the only sense a delete can be: a second call for the same id is RESOURCE_NOT_FOUND, indistinguishable from an id that never existed.

Required ability

support-canned-reply:delete

Input schema

{
  "type": "object",
  "required": ["project_id", "canned_reply_id"],
  "properties": {
    "project_id": {
      "type": "string",
      "description": "UUID of the project the snippet belongs to."
    },
    "canned_reply_id": {
      "type": "string",
      "description": "UUID of the saved reply to remove."
    }
  }
}

Output shape

{
  "data": {
    "canned_reply_id": "5d2f8a71-3c9e-4b06-a8f4-1e7c9d2b6a35",
    "deleted": true
  }
}

The id is echoed as sent. Nothing else about the snippet is returned, so read it first if the text matters.

Example prompts

"Delete saved reply 5d2f8a71-3c9e-4b06-a8f4-1e7c9d2b6a35 from project 7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13 — the refund terms changed."

"Remove the 'Black Friday' snippet now the sale is over."

"Clear out every saved reply that mentions the old bot name." (list, confirm the set with the creator, then delete each)

Failure modes

• VALIDATION_FAILED — the token's owner is on the project's team but their role lacks the support permission on it.
• RESOURCE_NOT_FOUND — project_id names a project the token cannot see, or canned_reply_id is unknown, already deleted, or belongs to another project.
• AUTHENTICATION_REQUIRED — no authenticated user on the request.
• TOKEN_MISSING_ABILITY — token lacks support-canned-reply:delete.

Related

• get_canned_reply — read it before removing it.
• update_canned_reply — the narrower fix when only the wording is wrong.
• support.canned_reply.deleted — the event this raises.
• Support canned replies API — DELETE /v1/projects/{project}/support/canned-replies/{reply}.
• Support inbox — the feature walkthrough.