Record what came of a weekly review area.

Records that the agent looked into an area of Candor's weekly review, with what the records or the person showed, or that it is set aside, with why it does not apply. area is the review.area item's id from the opening. The person sees the outcome on the dashboard, the area leaves the opening, and the next review reads it. Recording again replaces the outcome. Returns the area as saved.

post/v1/reviews/update

Request

  • Base URL: https://api.candor.money
  • URL: https://api.candor.money/v1/reviews/update
  • Auth: HTTP bearer

Headers

Idempotency-Keystring required

Stable opaque identity for one logical POST. Reuse only with the same method, path, actor, and body for transport retries. A completed receipt replays its original result, including a refusal; changed input with the same key is rejected. After a refused action and access recovery, use a new key for the new attempt. Follow retryable and recovery guidance if the operation is still running or its outcome is unknown.

Request body

areastring required

The review.area item's id from the opening.

outcome'looked_into' | 'set_aside' required

looked_into with what the records or the person showed; set_aside with why it does not apply.

foundstring required

What the records or the person showed, or why it does not apply, in plain words. The person reads it on the dashboard.

Example request

{
  "area": "review.area:k57abc:area_1",
  "found": "A transfer to refill checking was already on its way and landed Sep 23."
}

Response

Saved area envelope.

schema_versionstring required
generated_atstring date-time required
request_idstring required
status'success' | 'partial_success' | 'action_required' | 'error' required
user_messagestring

Optional concise user-safe message the calling agent may adapt.

warningsobject[] required
dataobject nullable required

Operation-specific result data, or null when the request ends in an error.

Changes

No recorded changes to this operation across all 1 revision of this API.