Skip to main content

​
Update project

Update a project’s metadata including name, description, visibility, and social links.

​
Endpoint

PUT /api/projects/:projectId

​
Authentication

Requires JWT authentication. Only the project owner can update their project.

​
Path Parameters

​
projectId
string
required
The unique identifier of the project to update

​
Request Body

​
name
string
New project name
​
description
string
New project description
​
isPublic
boolean
Whether the project should be publicly visible
​
websiteUrl
string
Project website URL
​
githubUrl
string
GitHub repository URL
​
twitterUrl
string
Twitter/X profile URL
​
discordUrl
string
Discord server invite URL

​
Response

​
success
boolean
Whether the update was successful
​
project
object
Updated project object

​
Example

curl -X PUT https://api.orquestra.dev/api/projects/abc123 \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My Updated Project",
    "description": "An improved description",
    "isPublic": true,
    "websiteUrl": "https://myproject.com",
    "githubUrl": "https://github.com/user/project"
  }'

​
Error Responses

Missing or invalid JWT token
User is not the project owner
Project does not exist
Invalid request data (e.g., invalid URL format)

​
Next Steps

Delete project

Learn how to delete a project

Build docs developers (and LLMs) love

Get started for freeTalk to us