Change Final Document Status
Use correct API token
Ensure the correct API token is used for updating the document's final status. Only the token linked to the specific TranscriptSession can be used.
Update the status of a document to indicate it is finalized or not, thereby preventing further edits when marked as finished.
URL: PUT https://api.scriptix.io/api/v3/speech-to-text/session/${sessionId}/document/${documentId}/finished_status
Request Headers
| Parameter | Value | Description |
|---|---|---|
| Content-Type | application/json | |
| X-Zoom-S2T-Key | Scriptix Batch API Token | API key belonging to TranscriptSession |
Request Path Arguments
| Argument | Description |
|---|---|
| sessionId | Scriptix Transcript Session ID returned from a Batch Session |
| documentId | Scriptix Document ID returned from Get Document or Create Document |
Query Parameters
| Key | Type | Default | Description |
|---|---|---|---|
| status | bool |
false |
Set to true to mark the document as finished. |
Response Codes
| Status Code | Description |
|---|---|
| 204 | Document status successfully updated |
| 400 | Bad request, e.g., if the document is already finished |
| 401 | Unauthorized, invalid authentication |
| 403 | Forbidden, access not allowed for the token provided |
| 404 | Document not found or does not belong to the session |