Message Groups

Trash message group

Trash all messages in a group, including future messages. For an Office 365 message source, each message will be moved to the "Recoverable Items" folder. For a Google Workspace message source, the "Trash" label will be added to each message.

post/v0/message-groups/{id}/trash

Request

  • Base URL
    https://platform.sublime.security
  • URL
    https://platform.sublime.security/v0/message-groups/{id}/trash
  • Auth
    HTTP bearer

Path parameters

idstring required

Canonical ID of the message group to trash

Request body

classification'malicious' | 'benign' | 'spam' | 'graymail' | 'simulation' | 'unwanted' | 'violation' | 'non-violation'

Classification to apply to the messages being reviewed. Optional.

report_label'spam' | 'phishing' | 'false_positive' | 'false_negative' | 'phishing_simulation' | 'graymail' | 'violation' | 'non-violation'

Label to apply to messages being reviewed. Optional.

review_commentstring nullable

Comment describing reason for action

Response

Accepted

task_idstring uuid required

Task ID. Use the /v0/tasks/:id endpoint to check the task status.

Changes

No recorded changes to this operation across all 2 revisions of this API.