Sign in
Projects

Update a project

Changed on

Update the supplied project fields.

patch/projects/{projectId}

Request

  • Base URL: https://next-api.saturation.io/v1
  • URL: https://next-api.saturation.io/v1/projects/{projectId}
  • Auth: HTTP bearer

Request body

namestring
slugstring
emojistring nullable
imagestring nullable
summarystring nullable
spaceIdstring

A stable resource ID, such as prj_…, txn_…, or doc_….

status'active' | 'archived'
projectTypestring nullable

Project type shown in Saturation.

tagIdsId[]

Replaces the project's tags. Send an empty array to remove all tags.

Example request

{
  "spaceId": "txn_8f2a1c9e",
  "tagIds": [
    "txn_8f2a1c9e"
  ]
}

Response

The updated project.

idstring required

A stable resource ID, such as prj_…, txn_…, or doc_….

slugstring required

The project's human handle, unique per workspace.

namestring required

Display name.

emojistring nullable

Emoji shown with the project.

imagestring nullable

Cover image URL.

status'active' | 'archived' required

Project status.

summarystring nullable

A short project summary.

spaceIdstring

A stable resource ID, such as prj_…, txn_…, or doc_….

projectTypestring nullable

Production format, such as Feature film or Commercial.

createdAtstring date-time required

ISO 8601 creation time.

updatedAtstring date-time required

ISO 8601 last update time.

Example response

{
  "id": "txn_8f2a1c9e",
  "slug": "q3-feature-doc",
  "name": "Q3 Feature Doc",
  "spaceId": "txn_8f2a1c9e",
  "tags": [
    {
      "id": "txn_8f2a1c9e"
    }
  ],
  "createdBy": {
    "id": "txn_8f2a1c9e"
  },
  "assumptions": {
    "noteId": "txn_8f2a1c9e"
  }
}

Changes