Update Transcription Group

curl --request POST \
  --url https://api.heify.com/update-transcription-group \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "transcription_id": "1a2b3c4d-e5f6-7890-1234-567890abcdef",
  "group": "PENDING_REVIEW"
}
'

{
  "data": {
    "message": "Transcription group updated successfully.",
    "transcription": {
      "transcription_id": "be340280-2618-43f7-9632-ef51fe91906e",
      "status": "COMPLETED",
      "configuration_id": "3b8006ad-b1a2-464b-9a6b-79dcd45c9433",
      "configuration_tag": "Pitch Analysis DEMO",
      "duration": 542.82,
      "group": "PENDING_REVIEW",
      "name": null,
      "participant_id": null,
      "evaluator_id": null,
      "participant_tag": null,
      "evaluator_tag": null,
      "details": {
        "language": "en",
        "num_speakers": 4,
        "created_at": "2026-03-21T12:51:39.990670+00:00",
        "completed_at": "2026-03-21T12:52:00.274673+00:00",
        "conversation": null,
        "summary": null,
        "fields": null,
        "evaluation": null
      }
    }
  }
}

POST

update-transcription-group

curl --request POST \
  --url https://api.heify.com/update-transcription-group \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "transcription_id": "1a2b3c4d-e5f6-7890-1234-567890abcdef",
  "group": "PENDING_REVIEW"
}
'

{
  "data": {
    "message": "Transcription group updated successfully.",
    "transcription": {
      "transcription_id": "be340280-2618-43f7-9632-ef51fe91906e",
      "status": "COMPLETED",
      "configuration_id": "3b8006ad-b1a2-464b-9a6b-79dcd45c9433",
      "configuration_tag": "Pitch Analysis DEMO",
      "duration": 542.82,
      "group": "PENDING_REVIEW",
      "name": null,
      "participant_id": null,
      "evaluator_id": null,
      "participant_tag": null,
      "evaluator_tag": null,
      "details": {
        "language": "en",
        "num_speakers": 4,
        "created_at": "2026-03-21T12:51:39.990670+00:00",
        "completed_at": "2026-03-21T12:52:00.274673+00:00",
        "conversation": null,
        "summary": null,
        "fields": null,
        "evaluation": null
      }
    }
  }
}

group is the only updatable field on a transcription. All other fields are set during processing and are immutable.

For valid group values and their meaning in the review workflow, see Transcription — group.

Pass "" (empty string) as group to clear it (sets the field to null).

Returns 404 if the transcription is not found.

The response includes the full updated transcription — same structure as Get Transcription.

Authorizations

x-api-key

string

header

required

Body

application/json

transcription_id

string<uuid>

required

The unique identifier of the transcription to update.

group

string

required

New group value. Valid values: PENDING_REVIEW, UNDER_REVIEW, ARCHIVED. Pass "" (empty string) to clear the group.

Response

200 - application/json

Group updated successfully. Returns the full, updated transcription object.

data

object

Show child attributes

List Transcriptions Delete Transcription