Skip to content

API reference

Update a project

PATCH/v1/projects/{projectId}

Authorization

Send a personal API key or an OAuth access token as Authorization: Bearer <token>.

OAuth scopes: projects:write

Parameters

  • projectIdstring (uuid), pathrequired

Request body

application/json, required

  • namestring
  • descriptionstring | null
  • visibility"private" | "team"
  • memoryScope"project" | "workspace"

Responses

200Success
  • projectobjectrequired
  • idstringrequired
  • namestringrequired
  • descriptionstring | nullrequired
  • visibility"private" | "team"required
  • memoryScope"project" | "workspace"required
  • taskCountnumberrequired
  • createdAtstringrequired
  • updatedAtstringrequired
400Invalid request
  • errorobjectrequired
  • typestringrequired
  • messagestringrequired
  • requestIdstring
401Missing or invalid Bearer credential
  • errorobjectrequired
  • typestringrequired
  • messagestringrequired
  • requestIdstring
402Payment or subscription required
  • errorobjectrequired
  • typestringrequired
  • messagestringrequired
  • requestIdstring
403Credential is missing a required scope
  • errorobjectrequired
  • typestringrequired
  • messagestringrequired
  • requestIdstring
404Resource not found
  • errorobjectrequired
  • typestringrequired
  • messagestringrequired
  • requestIdstring
409Request conflict
  • errorobjectrequired
  • typestringrequired
  • messagestringrequired
  • requestIdstring
429Rate limit exceeded
  • errorobjectrequired
  • typestringrequired
  • messagestringrequired
  • requestIdstring
500Internal API error
  • errorobjectrequired
  • typestringrequired
  • messagestringrequired
  • requestIdstring