Skip to main content

Update a Project

PATCH /v1/projects/:id

Update a project folder's name, description, or thumbnail. All fields are optional — only the ones you include are changed.

Request body

ParameterTypeRequiredDescription
namestringNoNew display name (1–200 chars)
descriptionstringNoNew description (up to 1000 chars)
thumbnailUrlstring | nullNoNew thumbnail URL — pass null to clear

Example

curl -X PATCH https://api.vidocu.ai/v1/projects/0f7c1d8a-2c4b-4a9c-9f2a-1b8a3a5e0c11 \
-H "Authorization: Bearer vdo_live_your_key_here" \
-H "Content-Type: application/json" \
-d '{ "name": "Q1 Launch (Updated)" }'

Response 200 OK

Returns the updated project.

{
"id": "0f7c1d8a-2c4b-4a9c-9f2a-1b8a3a5e0c11",
"name": "Q1 Launch (Updated)",
"description": "All onboarding and demo videos for the Q1 launch",
"thumbnailUrl": null,
"createdAt": "2026-04-27T10:00:00.000Z",
"updatedAt": "2026-04-27T10:15:00.000Z"
}

Required scope

OAuth tokens need the projects:write scope.

Errors

StatusCodeCause
400validation_errorInvalid field value
401authentication_errorInvalid or missing API key
403insufficient_scopeOAuth token missing projects:write
404not_foundProject does not exist or belongs to a different workspace