Skip to content

POST · Bearer

POST /api/v1/inboxes/:id/rules/test

Summary

Dry run. Body is {message_id} for stored enabled rules, or a rule body plus message_id for one unsaved rule. Returns matching rules, actions that would run, and skipped actions with reasons. No side effects. Read permission is message_read.

Request

{
  "message_id": "msg_example"
}

Response

The OpenAPI document does not declare a JSON response schema for this call. The summary is the contract.

Errors

The summary and the OpenAPI operation do not name an error code.

Idempotency

This route does not document Idempotency-Key or client_id.