# Update a recording's Recording ID

> PATCH /api/v1/workflow-recordings/{id} — request parameters and responses from the Menace Voice API schema.

`PATCH /api/v1/workflow-recordings/{id}`

{/* Generated by scripts/sync_docs_api.mjs. Edit the API schema source to change the contract. */}

See [authentication](/api-reference/authentication) for workspace API access. Public embed and artifact endpoints use their documented session or access tokens.

## API contract for documentation tools

Generated from the OpenAPI schema. Do not infer a different parameter type from an example. Authentication headers are alternatives as explained in the authentication guide.

### Parameters

| Name | Location | Type | Required | Description and constraints |
| --- | --- | --- | --- | --- |
| id | path | integer | yes |  |
| authorization | header | string or null | no |  |
| X-API-Key | header | string or null | no |  |

### Request body: application/json

Required body. Schema: RecordingUpdateRequestSchema (object).

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| recording_id | string | yes | New descriptive recording ID (letters, numbers, hyphens, underscores only) minLength: 1; maxLength: 64; pattern: "^[a-zA-Z0-9_-]+$" |

### Response 200

Successful Response

application/json: RecordingResponseSchema (object).

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| id | integer | yes |  |
| recording_id | string | yes |  |
| workflow_id | integer or null | no |  |
| organization_id | integer | yes |  |
| tts_provider | string or null | no |  |
| tts_model | string or null | no |  |
| tts_voice_id | string or null | no |  |
| transcript | string | yes |  |
| storage_key | string | yes |  |
| storage_backend | string | yes |  |
| metadata | object | yes |  |
| created_by | integer | yes |  |
| created_at | string | yes | format: "date-time" |
| is_active | boolean | yes |  |

### Response 404

Not found

### Response 422

Validation Error

application/json: HTTPValidationError (object).

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| detail | array of ValidationError (object) | no |  |

## OpenAPI

````yaml api-reference/openapi.json patch /api/v1/workflow-recordings/{id}
openapi: 3.1.0
info:
  title: Menace Voice API
  description: API for Menace Voice agents
  version: 1.0.0
servers:
  - url: https://voice.menaceui.com
    description: Production
  - url: http://localhost:8000
    description: Local development
paths:
  /api/v1/workflow-recordings/{id}:
    patch:
      tags:
        - main
        - workflow-recordings
      summary: Update a recording's Recording ID
      description: Update the recording_id (descriptive name) of a recording.
      operationId: update_recording_api_v1_workflow_recordings__id__patch
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
            title: Id
        - name: authorization
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: "null"
            title: Authorization
        - name: X-API-Key
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: "null"
            title: X-Api-Key
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/RecordingUpdateRequestSchema"
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/RecordingResponseSchema"
        "404":
          description: Not found
        "422":
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HTTPValidationError"
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: "#/components/schemas/ValidationError"
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    RecordingResponseSchema:
      properties:
        id:
          type: integer
          title: Id
        recording_id:
          type: string
          title: Recording Id
        workflow_id:
          anyOf:
            - type: integer
            - type: "null"
          title: Workflow Id
        organization_id:
          type: integer
          title: Organization Id
        tts_provider:
          anyOf:
            - type: string
            - type: "null"
          title: Tts Provider
        tts_model:
          anyOf:
            - type: string
            - type: "null"
          title: Tts Model
        tts_voice_id:
          anyOf:
            - type: string
            - type: "null"
          title: Tts Voice Id
        transcript:
          type: string
          title: Transcript
        storage_key:
          type: string
          title: Storage Key
        storage_backend:
          type: string
          title: Storage Backend
        metadata:
          additionalProperties: true
          type: object
          title: Metadata
        created_by:
          type: integer
          title: Created By
        created_at:
          type: string
          format: date-time
          title: Created At
        is_active:
          type: boolean
          title: Is Active
      type: object
      required:
        - id
        - recording_id
        - organization_id
        - transcript
        - storage_key
        - storage_backend
        - metadata
        - created_by
        - created_at
        - is_active
      title: RecordingResponseSchema
      description: Response schema for a single recording.
    RecordingUpdateRequestSchema:
      properties:
        recording_id:
          type: string
          maxLength: 64
          minLength: 1
          pattern: ^[a-zA-Z0-9_-]+$
          title: Recording Id
          description: New descriptive recording ID (letters, numbers, hyphens,
            underscores only)
      type: object
      required:
        - recording_id
      title: RecordingUpdateRequestSchema
      description: Request schema for updating a recording's ID.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
````