Edit a Transcript

Partially update a transcript's metadata. Only fields that are explicitly provided will be changed.

All body parameters can alternatively be provided as HTTP headers prefixed with x-transcript- (e.g. x-transcript-slug). Headers take precedence over body fields.

Request Body

Parameter	Type	Description
idrequired	string	The transcript's internal ID (e.g. `j57abc123...`) as returned by the Create or List endpoints. Can also be passed as a query parameter: `?id=...`
name	string	New display name for the transcript.
slug	string	New custom slug for the transcript URL. Must be unique within your project.
protected	boolean	Whether to enable password protection.
password	string	New password for the transcript. Pass an empty string (`""`) to clear the existing password.
requiredRoles	array	An array of Discord Role IDs required to view this transcript. This engages Discord OAuth on the transcript viewer. Requires Discord Sync to be configured.
path_prefix	string	Update the path prefix for this transcript's URL. Can include variables like `{project}`, `{date}`, etc.

PATCH

https://bgplus.robbiee.com/api/v1/edit

Headers

x-api-token: your_api_token

Body (Raw JSON)

json

{
  "id": "{transcript_id}",
  "name": "{new_name}",
  "slug": "{new_slug}",
  "protected": {true/false},
  "requiredRoles": ["role_id_1", "role_id_2"],
  "path_prefix": "new-prefix/{date}"
}

Response Body

Parameter	Type	Description
success	boolean	Identifies if the update was successful.
id	string	The unique internal ID for the transcript.
slug	string	The unique slug used in the URL.

Example Response

json

{
  "success": true,
  "id": "j57abc123...",
  "slug": "updated-slug"
}

Note: POST is also accepted as a backwards-compatible alias for PATCH.

List Transcripts

Delete Transcript