Skip to content
ShuttleShuttle Docs
Status
View as MarkdownPlain text for AI toolsOpen in ClaudeAsk questions about this pageOpen in ChatGPTAsk questions about this pageOpen in GitHub CopilotAsk questions about this page

Delete a note or an attachment

Removes a comment from a record’s comments section, with every file attached to it, or removes a single file from a comment and leaves the comment itself in place. Operators use it to take back a comment they wrote, or to drop a file they attached to one while editing it. Both are immediate and cannot be undone.

Where you can do this

Section titled “Where you can do this”
  • Merchant View: Comments (Delete Comment)
  • Merchant View: Comments (x on the attachment)

Before you start

Section titled “Before you start”
  • The note exists.
  • To delete an attachment, the attachment is one of those the note reports.

Inputs

Section titled “Inputs”

Both routes take their inputs from the path; neither reads a request body.

Rules

Section titled “Rules”

Checked by the API means Shuttle refuses the request however it is sent; a screen name means only that screen refuses it, and a direct API call would be accepted.

Rule Checked by What you see
The note must exist. The two routes check it at different points and so report the same code with different wording The API NOT_FOUND “Object not found: note ” on the note route; NOT_FOUND “Note not found” on the attachment route
On the contract screen Merchant View also requires the contract permission (payment_contract) to delete a comment; on every other screen no permission is needed Merchant View screen control hidden

What happens

Section titled “What happens”
  • Deleting a comment removes it from the record’s comments for everyone, together with every file attached to it. The reply is 204 with no body, and there is no way back: the files are destroyed and the comment cannot be restored to the record.
  • Deleting an attachment removes that one file from the comment and leaves the comment, its text and its other files as they were. The reply is 204 with no body. In Merchant View the removal is only marked while editing and is sent when the comment is saved.
  • Any link already shared to a removed file stops working, including a public comment’s public_url when the file removed was the first attachment on it.
  • Nothing is announced: no webhook, no email or SMS, and no entry in the record’s history. A comment on a contract raises CONTRACT.NOTE when it is written and again when it is edited, but nothing when it is deleted, so an integration that reacted to the comment is never told it has gone.
  • A deleted comment is still returned by a fetch of the note by its own id, with its attachments still listed although their files have been destroyed. Only the record’s comments stop showing it.

Who can do this

Section titled “Who can do this”
  • Roles: Admin and Support.
  • Admin app: option comments shows the comments section; Delete is offered on the signed-in user’s own comments only, on the contract screen only with payment_contract, and on the terminal batch screens only while the batch is open.
Section titled “Related”

Was this page helpful?