qualificationSessions

Update mutable fields on a qualification session

Keep a qualification session in sync with your own records after you've created it. Attach your internal user identifier, store free-form metadata, and adjust the redirect URLs a customer returns to once they finish qualifying.

Request Notes

  • idempotency_key makes retries safe: a duplicate POST with the same key against the same qualification session is deduplicated and returns the original response, while reusing a key with a different payload returns a 400 validation error.
  • user_id is set-when-null only: you can supply it while the qualification session has no user_id yet, but attempting to overwrite a non-null value returns the documented user_id_already_set error code. Stale-value corrections must route through Truemed support, not this endpoint.
  • metadata is a JSON-encoded string echoing the same convention used by the create endpoint.
  • success_url and failure_url are still stored when supplied, but have no effect once the qualification session reaches a terminal status (approved / rejected) — the customer has already completed the flow and won't be redirected again.

Response Notes

  • status is a read-only passthrough — qualification-session status is never mutable via this endpoint. Status changes occur through the survey-submission and LMN-clinical-review flows.
post/api/v1/qualification_session/{qualification_session_id}/update

Request

  • Base URL: https://dev-api.truemed.com
  • URL: https://dev-api.truemed.com/api/v1/qualification_session/{qualification_session_id}/update
  • Auth: API key in header x-truemed-api-key

Path parameters

qualification_session_idstring required

The qualification session ID from the URL path.

Request body

failure_urlstring nullable

Optional failure redirect URL. Has no effect once the qualification session reaches a terminal status.

idempotency_keystring required

A unique key for safely retrying the request, scoped to this qualification session. Duplicate POSTs with the same key against the same qualification session are deduplicated and return the original response.

metadatastring nullable

Optional metadata string (JSON-encoded by convention).

success_urlstring nullable

Optional success redirect URL. Has no effect once the qualification session reaches a terminal status.

user_idstring nullable

Your stable, opaque identifier for the shopper. Can only be set when the qualification session does not already have one — attempting to overwrite an existing value returns the user_id_already_set error. To correct a previously set value, contact Truemed support.

Response

Successful response

qualification_session_idstring required

The qualification_session_id that was updated (echoed from the path param).

status'pending' | 'processing' | 'approved' | 'rejected' required

Qualification status summary for the v1 qualification-session surface.

Its wire values are the long-standing v1 contract (pending/processing/approved/rejected); the v2 Truemed Session surface uses TruemedSessionQualificationStatus with its own vocabulary, so the two evolve independently and v1 clients keep the values they already depend on.

It abstracts the internal nuances of the qualification session and LMN verification status. It is to be used by merchants external to Truemed.

Changes

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