PATCH
/
api
/
v1
/
projects
/
{projectId}
curl -X PATCH \
  https://studio.dubformer.ai/api/v1/projects/proj_5f83a14b2ec1b \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Updated Marketing Campaign 2023",
    "managerEmail": "new.manager@company.com",
    "translationsGlossaryId": "gloss_new_5f83a14b2ec1b",
    "voicesGlossaryId": ""
  }'
{
  "id": "proj_5f83a14b2ec1b",
  "name": "Updated Marketing Campaign 2023",
  "status": "new",
  "translationGlossary": "gloss_new_5f83a14b2ec1b",
  "voicesGlossary": null,
  "remark": null,
  "clientName": null,
  "projectUrl": "https://studio.dubformer.ai/projects/proj_5f83a14b2ec1b",
  "createdAt": "2023-12-01T10:00:00.000Z",
  "updatedAt": "2023-12-01T16:45:00.000Z"
}

Path Parameters

projectId
string
required
Unique identifier of the project to update.

Request Body

name
string
New name for the project.
managerEmail
string
Email of the new project manager. The manager must belong to the same company as the API key user.
translationsGlossaryId
string
ID of a translation glossary to be used for this project. Pass empty string to remove.
voicesGlossaryId
string
ID of a voices glossary to be used for this project. Pass empty string to remove.

Response

id
string
Unique project identifier.
name
string
Name of the project.
status
string
Current status of the project.
translationGlossary
string | null
ID of the translation glossary, if any.
voicesGlossary
string | null
ID of the voices glossary, if any.
remark
string | null
Project remarks, if any.
clientName
string | null
Client name, if specified.
projectUrl
string
URL to access the project in the web app.
createdAt
string
ISO 8601 timestamp when the project was created.
updatedAt
string
ISO 8601 timestamp when the project was last updated.
curl -X PATCH \
  https://studio.dubformer.ai/api/v1/projects/proj_5f83a14b2ec1b \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Updated Marketing Campaign 2023",
    "managerEmail": "new.manager@company.com",
    "translationsGlossaryId": "gloss_new_5f83a14b2ec1b",
    "voicesGlossaryId": ""
  }'
{
  "id": "proj_5f83a14b2ec1b",
  "name": "Updated Marketing Campaign 2023",
  "status": "new",
  "translationGlossary": "gloss_new_5f83a14b2ec1b",
  "voicesGlossary": null,
  "remark": null,
  "clientName": null,
  "projectUrl": "https://studio.dubformer.ai/projects/proj_5f83a14b2ec1b",
  "createdAt": "2023-12-01T10:00:00.000Z",
  "updatedAt": "2023-12-01T16:45:00.000Z"
}

Notes

This endpoint updates only basic project information. Videos can be managed using separate video management endpoints.
The project manager must belong to the same company as the API key user. If the specified manager is not found or doesn’t belong to the same company, the request will fail.
Translation and voices glossaries must exist and be accessible to your organization if provided. Pass an empty string to remove an existing glossary assignment.