Record how much help the user wants.

Records, on the user's word, how much help they want from their agent. in_depth, the default, has the opening ask what they are working toward and the household facts the records cannot show. essentials drops those questions; the opening still raises what needs action, and the agent answers what the user asks. The user can change it here or in the dashboard's settings. Returns the preference as saved.

post/v1/preferences/update

Request

  • Base URL: https://api.candor.money
  • URL: https://api.candor.money/v1/preferences/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

help_depth'in_depth' | 'essentials' required

in_depth asks what the user is working toward and the household facts the records cannot show; essentials raises what needs action and answers what they ask.

Example request

{
  "help_depth": "essentials"
}

Response

Saved preference 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.