Therapy Planning

Approve, modify, or reject a generated therapy plan. The action determines the next step: "approve" locks the plan as…

post/api/therapy-approve/{sessionId}

Request

  • Base URL: https://platform.vocametrix.com
  • URL: https://platform.vocametrix.com/api/therapy-approve/{sessionId}
  • Auth: API key in header X-API-Key

Path parameters

sessionIdstring required

Path parameter — the session ID. Status must be "complete" or "pending_approval".

Request body

actionstring required

REQUIRED in body. "approve" | "modify" | "reject" (case-insensitive).

feedbackstring

REQUIRED when action="modify". Free-form clinician notes describing what to change. Optional otherwise.

Response

Successful response

successboolean

Boolean.

therapy_session_idstring

Echo of the session ID.

actionstring

Echo of the action.

feedbackstring

Echo of the feedback (or null).

delivery_statusstring

On approve: "approved_pending_delivery". On reject: "rejected".

statusstring

On modify: "processing" — the workflow re-runs and the client must poll again.

status_messagestring

Human-readable description.

status_urlstring

(modify only) URL to poll the new run.

result_urlstring

(modify only) URL to fetch the new result.

timestampstring date-time

ISO 8601.

messagestring

Human-readable confirmation.

Changes

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