advice_session

[BETA] Partially update the advice-information answers for an advice session.

fields is merged into stored state at advisorInput.adviceInformation: field codes present overwrite, absent codes keep their stored value, and a code sent as null is stored as null (cleared). Omitting fields leaves stored answers unchanged; advisor_notes is updated only when present. Sibling keys and other namespaces inside advisorInput are preserved.

    Submitted values for configured choice fields are validated against their options;
    an invalid option code returns 400.

    The request mirrors the GET `data` shape; the response is a data-only echo of the
    merged state (`{data: {answers, advisor_notes}}`), without the `meta` block.
patch/v2/advice_session/{session_id}/advice_information

Request

  • Base URL: https://api.test.deepalpha.dev
  • URL: https://api.test.deepalpha.dev/v2/advice_session/{session_id}/advice_information
  • Auth: one of:
    • OAuth 2 (client credentials, token URL /v1/auth/token)
    • HTTP bearer

Path parameters

session_idstring uuid required

Request body

Response

Successful response

Changes

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