Flags API reference

Flags API · Projects

patch/v1/workspaces/{workspace_id}/projects/{project_id}Auth

Update a project

Rename, describe or reorder the project. Only the fields you send change. Needs `flags.project.manage`.

Path parameters

project_id*string · uuid

Id of the project.

workspace_id*string · uuid

Id of the workspace.

Request body

namestring

Display name, 1-100 characters, unique in the workspace.

Example: "Storefront"

descriptionstring

Free-text description, at most 1000 characters.

ordinalinteger

Sort position in the workspace.

Example: 0

notestring

A change note (at most 500 characters), saved on the history entry. Environments with `require_note` refuse value writes without one.

Example: "Ticket FLAG-142"

Response · 200 The updated project.

id*string · uuid

The project's id.

workspace_id*string · uuid

The workspace that owns the project.

name*string

Display name, unique in the workspace (case-insensitive).

Example: "Storefront"

description*string

Free-text description (may be empty).

Example: ""

ordinal*integer

Sort position in the workspace (ascending).

Example: 0

environments*array

The project's environments, in `ordinal` order.

configs*array

The project's configs, in `ordinal` order.

created_at*string · date-time

When the project was created.

updated_at*string · date-time

When the project last changed.

Example

Request

PATCH https://api.flags.productcraft.co/v1/workspaces/{workspace_id}/projects/{project_id}
Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

{
  "name": "Storefront",
  "description": "string",
  "ordinal": 0,
  "note": "Ticket FLAG-142"
}

Response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "workspace_id": "00000000-0000-0000-0000-000000000000",
  "name": "Storefront",
  "description": "",
  "ordinal": 0,
  "environments": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "workspace_id": "00000000-0000-0000-0000-000000000000",
      "project_id": "00000000-0000-0000-0000-000000000000",
      "key": "production",
      "name": "Production",
      "color": "#c92a2a",
      "ordinal": 1,
      "protected": true,
      "require_note": false,
      "created_at": "2026-01-01T00:00:00.000Z",
      "updated_at": "2026-01-01T00:00:00.000Z"
    }
  ],
  "configs": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "workspace_id": "00000000-0000-0000-0000-000000000000",
      "project_id": "00000000-0000-0000-0000-000000000000",
      "key": "main",
      "name": "Main",
      "description": "",
      "ordinal": 0,
      "created_at": "2026-01-01T00:00:00.000Z",
      "updated_at": "2026-01-01T00:00:00.000Z"
    }
  ],
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}