> ## Documentation Index > Fetch the complete documentation index at: https://www.tella.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Update a playlist > Update a playlist's name and/or description ## OpenAPI ````yaml /openapi.json patch /v1/playlists/{id} openapi: 3.0.3 info: description: >- The Tella Public API allows you to programmatically access your videos and playlists, including transcripts, chapters, and thumbnails. ## Authentication All requests require a Bearer token in the Authorization header: ``` Authorization: Bearer tella_pk_xxxxx... ``` API keys can be generated in your Tella workspace settings. ## Rate Limiting The API is rate-limited to 100 requests per minute per organization. Rate limit information is returned in response headers: - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets title: Tella Public API version: 1.0.0 servers: - description: Production url: https://api.tella.com security: [] tags: - description: Video operations name: Videos - description: Sections of a video name: Clips - description: Playlist operations name: Playlists - description: Sidebar groups for organizing playlists name: Playlist Groups - description: Tags for categorizing and filtering videos name: Tags - description: Webhook endpoint management name: Webhooks paths: /v1/playlists/{id}: patch: tags: - Playlists summary: Update a playlist description: Update a playlist's name and/or description operationId: updatePlaylist parameters: - description: Unique playlist identifier in: path name: id required: true schema: description: Unique playlist identifier example: pl_abc123def456 type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdatePlaylistRequest' required: true responses: '200': content: application/json: schema: additionalProperties: false properties: playlist: $ref: '#/components/schemas/PlaylistDetail' required: - playlist type: object description: OK '400': content: application/json: example: error: code: bad_request doc_url: https://tella.tv/docs/api-reference/errors#bad-request message: The request was malformed or contained invalid parameters. schema: $ref: '#/components/schemas/ErrorResponse' description: The request was malformed or contained invalid parameters. '401': content: application/json: example: error: code: unauthorized doc_url: https://tella.tv/docs/api-reference/errors#unauthorized message: Authentication is required. Provide a valid API key. schema: $ref: '#/components/schemas/ErrorResponse' description: Authentication is required. Provide a valid API key. '403': content: application/json: example: error: code: forbidden doc_url: https://tella.tv/docs/api-reference/errors#forbidden message: You don't have permission to access this resource. schema: $ref: '#/components/schemas/ErrorResponse' description: You don't have permission to access this resource. '404': content: application/json: example: error: code: not_found doc_url: https://tella.tv/docs/api-reference/errors#not-found message: The requested resource was not found. schema: $ref: '#/components/schemas/ErrorResponse' description: The requested resource was not found. '422': content: application/json: example: error: code: unprocessable_entity doc_url: >- https://tella.tv/docs/api-reference/errors#unprocessable-entity message: The request was well-formed but contained semantic errors. schema: $ref: '#/components/schemas/ErrorResponse' description: The request was well-formed but contained semantic errors. '429': content: application/json: example: error: code: rate_limit_exceeded doc_url: >- https://tella.tv/docs/api-reference/errors#rate-limit-exceeded message: You have exceeded the rate limit. Please slow down. schema: $ref: '#/components/schemas/ErrorResponse' description: You have exceeded the rate limit. Please slow down. '500': content: application/json: example: error: code: internal_server_error doc_url: >- https://tella.tv/docs/api-reference/errors#internal-server-error message: An unexpected error occurred on the server. schema: $ref: '#/components/schemas/ErrorResponse' description: An unexpected error occurred on the server. security: - BearerAuth: [] components: schemas: UpdatePlaylistRequest: additionalProperties: false description: >- Request body for updating a playlist. At least one field must be provided. minProperties: 1 properties: description: description: Playlist description example: Updated description for the playlist maxLength: 5000 type: string groupId: description: >- Move the playlist into a playlist group (pg_...), or null to remove it from its group. The group's visibility must match the playlist's. example: pg_abc123def456 nullable: true type: string linkScope: allOf: - $ref: '#/components/schemas/PlaylistLinkScope' description: Access level name: description: Playlist name example: Updated Playlist Name maxLength: 255 minLength: 1 type: string password: description: >- Password for viewing. Required when linkScope is 'password', ignored otherwise. example: newpassword maxLength: 255 minLength: 1 type: string position: description: >- 0-based position within the playlist's container (0 = top): its group when grouped, otherwise the sidebar section across groups and ungrouped playlists. Combine with groupId to move into a group at a specific position. example: 0 maximum: 9007199254740991 minimum: 0 type: integer searchEngineIndexingEnabled: description: Allow search engine indexing example: true type: boolean type: object PlaylistDetail: additionalProperties: false description: Detailed information about a playlist properties: createdAt: description: ISO 8601 datetime example: '2024-01-15T10:30:00.000Z' format: date-time type: string description: description: Playlist description example: A collection of tutorial videos for our product maxLength: 5000 type: string emoji: description: Unicode emoji character for the playlist example: 🎬 maxLength: 10 type: string groupId: description: >- Playlist group this playlist belongs to in the sidebar, or null if ungrouped example: pg_abc123def456 nullable: true type: string id: description: Unique playlist identifier example: pl_abc123def456 type: string linkScope: allOf: - $ref: '#/components/schemas/PlaylistLinkScope' description: Access level for the playlist links: allOf: - $ref: '#/components/schemas/PlaylistLinks' description: Related URLs for the playlist name: description: Playlist name example: Product Tutorials maxLength: 255 minLength: 1 type: string searchEngineIndexingEnabled: description: Whether search engines can index this playlist example: true type: boolean updatedAt: description: ISO 8601 datetime example: '2024-01-15T14:45:00.000Z' format: date-time type: string videos: description: Number of videos in the playlist example: 12 maximum: 9007199254740991 minimum: 0 type: integer visibility: allOf: - $ref: '#/components/schemas/PlaylistVisibility' description: Whether playlist is shared with org or personal to creator required: - id - name - description - emoji - videos - linkScope - searchEngineIndexingEnabled - visibility - groupId - createdAt - updatedAt - links type: object ErrorResponse: additionalProperties: false description: Standard error response format properties: error: additionalProperties: false description: Error details properties: code: description: Machine-readable error code enum: - bad_request - unauthorized - forbidden - not_found - unprocessable_entity - rate_limit_exceeded - internal_server_error example: not_found type: string doc_url: description: Link to documentation for this error example: https://tella.tv/docs/api-reference/errors#not-found format: uri type: string message: description: Human-readable error message example: The requested resource was not found. type: string required: - code - message - doc_url type: object required: - error type: object PlaylistLinkScope: description: >- Access level: public (anyone with link), private (org members only), password (requires password), embedonly (only viewable when embedded) enum: - public - private - password - embedonly example: public type: string PlaylistLinks: additionalProperties: false description: URLs related to a playlist properties: viewPage: description: URL to view the playlist on Tella example: https://www.tella.tv/playlist/pl_abc123def456/view format: uri type: string required: - viewPage type: object PlaylistVisibility: description: >- Visibility: org (shared with entire organization) or personal (only creator) enum: - org - personal example: org type: string securitySchemes: BearerAuth: description: API key obtained from your Tella account settings scheme: bearer type: http ````