Sign in
advice_session

[BETA] Replace the external metadata for a session.

The body is a JSON:API data document ({data, meta}); data is required (may be null to clear) and free-form. The whole document is replaced (idempotent). Only allowed while the session is open; posting to a completed/cancelled session returns 400.

put/v2/advice_session/{session_id}/meta

Request

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

Path parameters

session_idstring uuid required

Request body

dataobject nullable required

Free-form external result (e.g. a pre-order check outcome). Null when unset.

metaobject nullable

Free-form top-level details.

Response

Successful response

dataobject nullable required

Free-form external result (e.g. a pre-order check outcome). Null when unset.

metaobject nullable

Free-form top-level details.

Changes

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