Sign in
Projects

Update project

Updates a project. Accessible fields depend on user permissions.

patch/projects/{id}

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/projects/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key

Path parameters

idstring required
Example:1357158568008091264

ID of the project to update

Request body

ownerProjectManagerIdstring nullable

ID of the project manager who owns the project

backgroundImageIdstring nullable

ID of the background image used as background

namestring

Name/title of the project

descriptionstring nullable

Detailed description of the project

backgroundType'gradient' | 'image' nullable

Type of background for the project

backgroundGradient'old-lime' | 'ocean-dive' | 'tzepesch-style' | 'jungle-mesh' | 'strawberry-dust' | 'purple-rose' | 'sun-scream' | 'warm-rust' | 'sky-change' | 'green-eyes' | 'blue-xchange' | 'blood-orange' | 'sour-peel' | 'green-ninja' | 'algae-green' | 'coral-reef' | 'steel-grey' | 'heat-waves' | 'velvet-lounge' | 'purple-rain' | 'blue-steel' | 'blueish-curve' | 'prism-light' | 'green-mist' | 'red-curtain' nullable

Gradient background for the project

isHiddenboolean

Whether the project is hidden

isFavoriteboolean

Whether the project is marked as favorite by the current user

Example request

{
  "ownerProjectManagerId": "1357158568008091265",
  "backgroundImageId": "1357158568008091266",
  "name": "Development Project",
  "description": "A project for developing new features...",
  "backgroundType": "gradient",
  "backgroundGradient": "ocean-dive",
  "isFavorite": true
}

Response

Project updated successfully

Example response

{
  "item": {
    "id": "1357158568008091264",
    "ownerProjectManagerId": "1357158568008091265",
    "backgroundImageId": "1357158568008091266",
    "name": "Development Project",
    "description": "A project for developing new features...",
    "backgroundType": "gradient",
    "backgroundGradient": "ocean-dive",
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-01T00:00:00.000Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.