> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Run a retained message's routing decision again

> Records who asked, when and why, and the rail runs the same routing decision a new message gets — send journal, ownership map, declared rules — on its next pass. Engines named release the message to them; a declared refusal refuses it, citing the rule; otherwise it stays retained, under the cause the decision found. The operator never chooses the engine. Only a releasable retention can be re-evaluated (JDC-0204 otherwise), and only while it is still retained (JDC-0202). Idempotent per X-Idempotency.



## OpenAPI

````yaml /en/openapi/v3-current/jd-courier.yaml post /v1/retained/{messageId}/reevaluate
openapi: 3.1.0
info:
  description: >-
    The JD Courier API. Operators use it to manage the engines, the ownership
    map, the delivery modes and bypass of each rail, the retained messages, the
    SPB send journal and reconciliation. Engines use it to resolve the owner of
    a key, claim their Pix Automático recurrences and declare their Pix
    Automático payment legs.
  title: JD Courier API
  version: v1.0.0
servers: []
security:
  - BearerAuth: []
tags:
  - description: >-
      The engine registry: the cores that consume the JD channel through the
      Courier, each with its participant set
    name: Engines
  - description: 'The ownership map: which engine owns each key. Every change is audited.'
    name: ownership
  - description: >-
      The rails: what each declares about itself, its state per tenant, and the
      bypass declaration
    name: channels
  - description: >-
      The engines' side of the ownership map: resolution for the on-us gate,
      authoritative and never advisory, the claim of a Pix Automático recurrence
      the engine holds, and the declaration of a payment leg it holds.
    name: ownership-query
  - description: >-
      The durable message store: redelivery on demand, without asking the vendor
      again
    name: ledger
  - description: >-
      Count reconciliation per rail: E(m) = C(m) + T(m) + R(m), the sequence
      gaps it saw, and the sends whose return leg never arrived
    name: assurance
  - description: >-
      The SPB send journal: every send, written before it leaves, and the sends
      whose outcome is unknown. A by-hand close records an operator's finding
      and never resends.
    name: send-journal
  - description: >-
      Per-(tenant, channel) state an operator acts on: lifting a durable channel
      halt
    name: channel-leases
  - description: >-
      Messages the Courier holds because no engine could receive them. A routing
      or delivery retention leaves by itself once its cause lifts, or when an
      operator asks for its routing decision to be run again.
    name: retained
paths:
  /v1/retained/{messageId}/reevaluate:
    post:
      tags:
        - retained
      summary: Run a retained message's routing decision again
      description: >-
        Records who asked, when and why, and the rail runs the same routing
        decision a new message gets — send journal, ownership map, declared
        rules — on its next pass. Engines named release the message to them; a
        declared refusal refuses it, citing the rule; otherwise it stays
        retained, under the cause the decision found. The operator never chooses
        the engine. Only a releasable retention can be re-evaluated (JDC-0204
        otherwise), and only while it is still retained (JDC-0202). Idempotent
        per X-Idempotency.
      operationId: reevaluateRetainedMessage
      parameters:
        - description: The message's surrogate id, from the listing.
          in: path
          name: messageId
          required: true
          schema:
            description: The message's surrogate id, from the listing.
            format: uuid
            type: string
        - description: >-
            Idempotency key; a retry with the same key and body replays the
            first answer.
          in: header
          name: X-Idempotency
          required: true
          schema:
            description: >-
              Idempotency key; a retry with the same key and body replays the
              first answer.
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReevaluateInputBody'
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetainedMessage'
          description: Accepted
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Bad Request
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Unauthorized
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Forbidden
        '404':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Not Found
        '409':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Conflict
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Unprocessable Entity
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Internal Server Error
        '503':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Service Unavailable
components:
  schemas:
    ReevaluateInputBody:
      additionalProperties: false
      properties:
        reason:
          description: >-
            Why the decision should be run again. 1 to 512 characters after
            trimming.
          type: string
      required:
        - reason
      type: object
    RetainedMessage:
      additionalProperties: false
      properties:
        channelId:
          enum:
            - spb
            - pix
          type: string
        messageId:
          format: uuid
          type: string
        receivedAt:
          format: date-time
          type: string
        reevaluatedAt:
          description: >-
            The last time the rail tried its routing decision again and the
            message stayed retained, whether the decision ran or failed; null
            when it never tried.
          format: date-time
          type:
            - string
            - 'null'
        reevaluation:
          $ref: '#/components/schemas/ReevaluationRequest'
          description: The last operator request to re-evaluate it; null when nobody asked.
        releasable:
          description: >-
            True when the cause is routing or delivery: no owner in the map, a
            map that could not answer, an owner disabled or unreachable, no
            delivery mode declared for its code. Only these are re-checked by
            themselves once the cause lifts, and only these can be re-evaluated;
            a Pix retention also clears when the vendor resends it. An
            UNRECOGNIZED_TYPE of a non-financial code releases once a delivery
            mode is declared for its code and is not re-checked before that; one
            of a financial code releases on the re-check after a Courier release
            reads its destination.
          type: boolean
        retainedAt:
          format: date-time
          type: string
        retentionReason:
          type: string
      required:
        - messageId
        - channelId
        - retentionReason
        - releasable
        - receivedAt
        - retainedAt
        - reevaluatedAt
      type: object
    Detail:
      additionalProperties: true
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-NNNN).
          type: string
        detail:
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          examples:
            - Property foo is required but is missing.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
            - array
            - 'null'
        instance:
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: HTTP status code
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            A short, human-readable summary of the problem type. This value
            should not change between occurrences of the error.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
        upstream:
          $ref: '#/components/schemas/Upstream'
          description: >-
            RFC 9457 extension member: the error a proxied third-party provider
            reported. Absent unless the emitting service explicitly surfaced
            one.
      type: object
    ReevaluationRequest:
      additionalProperties: false
      properties:
        pending:
          description: >-
            True until the rail tries the routing decision again, on its next
            pass; a try that failed also answers the request.
          type: boolean
        reason:
          type: string
        requestedAt:
          format: date-time
          type: string
        requestedBy:
          type: string
      required:
        - requestedBy
        - requestedAt
        - reason
        - pending
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: >-
            Where the error occurred, e.g. 'body.items[3].tags' or
            'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
    Upstream:
      additionalProperties: false
      properties:
        code:
          description: The upstream provider's own error code, verbatim.
          examples:
            - E4001
          type: string
        message:
          description: >-
            The upstream provider's own error message, verbatim (bounded, never
            its raw response body).
          examples:
            - account not found at provider
          type: string
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.