Sign in
Projects

Create a project

Changed on

Create a project in the workspace. Read-only fields return 422 field_read_only when supplied.

post/projects

Request

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

Headers

Idempotency-Keystring required

Unique request key, 16 to 255 characters. Retrying the same request returns the first response. Missing or invalid keys return 400 validation; reuse with a different body returns 409 idempotency_conflict.

Request body

namestring required
slugstring

Unique project handle. Generated from name when omitted.

emojistring nullable
imagestring nullable
summarystring nullable
spaceIdstring

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

projectTypestring nullable

Production format, such as Feature film or Commercial.

tagIdsId[]

Project tag IDs to assign. Duplicate IDs are ignored.

Example request

{
  "name": "Q3 Feature Doc",
  "spaceId": "txn_8f2a1c9e",
  "tagIds": [
    "txn_8f2a1c9e"
  ]
}

Response

The created 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"
  },
  "defaultBudget": {
    "budgetId": "txn_8f2a1c9e",
    "estimatePhaseId": "txn_8f2a1c9e"
  }
}

Changes