advice_session

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

The block matching the investor type is merged into storage: field codes present in the body overwrite their stored value, codes that are absent are left untouched, and a code sent as null is stored as null (cleared). Omitting a block leaves it unchanged; advisor_notes is updated only when present. Sending a non-null block that does NOT match the investor type returns 400. Sibling keys and other namespaces inside advisorInput are preserved. Returns the merged block for the investor type.

patch/v2/advice_session/{session_id}/financial_situation

Request

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

Path parameters

session_idstring uuid required

Request body

advisor_notesstring nullable
company_financial_situationobject nullable
person_financial_situationobject nullable

Response

Successful response

Changes

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