post/project-templatesWrite operation

Capture a project as a template

The cell-local App re-authenticates the credential, verifies tenant ownership and the projects.templates.add plan permission, snapshots the source project with bounded list/task limits, and applies credential-bound idempotency.

Required scopes

project-templates:write

Request example

curl --request POST \
  --url 'https://api.de.teamgrid.app/v1/project-templates' \
  --header 'Authorization: Bearer $TEAMGRID_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "color": "example",
    "description": "string",
    "projectId": "string",
    "title": "string"
  }'

const response = await fetch('https://api.de.teamgrid.app/v1/project-templates', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "color": "example",
  "description": "string",
  "projectId": "string",
  "title": "string"
}),
})

const result = await response.json()

type ApiResponse = unknown

const response = await fetch('https://api.de.teamgrid.app/v1/project-templates', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "color": "example",
  "description": "string",
  "projectId": "string",
  "title": "string"
}),
})

const result: ApiResponse = await response.json()

teamgrid project-templates create \
  --data @payload.json \
  --idempotency-key REQUEST_KEY

Example response 2xx

{
  "data": {
    "attributes": {
      "archived": false,
      "color": "example",
      "createdAt": "2026-07-29T09:00:00.000Z",
      "description": "string",
      "developerRevision": "example",
      "developerUpdatedAt": "2026-07-29T09:00:00.000Z",
      "originProjectId": null,
      "snapshotVersion": 1,
      "stats": {
        "listCount": 0,
        "taskCount": 0
      },
      "title": "string",
      "updatedAt": "2026-07-29T09:00:00.000Z"
    },
    "id": "example",
    "type": "string"
  },
  "meta": {
    "requestId": "string"
  }
}

EndpointGerman region

Interactive request builder

Prepare this request

Build locally · nothing is sent

Region

Credential variable

Idempotency-Keyheader · required

JSON request bodyValid JSON

Generated cURL

The builder does not execute requests or persist credentials. Replace the environment-variable placeholder only in your terminal or secret-aware runtime.

Headers

Idempotency-Keyrequired

string

Unique request key retained for seven days. Within that window, reuse with different data is rejected.

Request body

application/json

colorrequired

string

Canonical color value used to display the resource.

description

string

Human-readable description of the resource.

projectIdrequired

string

Identifier of the related project.

titlerequired

string

Human-readable title of the resource.

Responses

200An idempotent replay of an existing resource.application/json

Response schemaapplication/json

required

ProjectTemplate

Safe project-template metadata. The captured project, list, and task snapshot, tenant fields, actor fields, and other storage internals are never exposed.

required

ResponseMeta

Public API representation of meta.

201The request to capture a project as a template created the resource. The response contains its canonical public representation and request metadata.application/json

Response schemaapplication/json

required

ProjectTemplate

Safe project-template metadata. The captured project, list, and task snapshot, tenant fields, actor fields, and other storage internals are never exposed.

required

ResponseMeta

Public API representation of meta.

400The request is invalid.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

401The bearer credential is missing, invalid, expired, or revoked.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

403The credential has insufficient scope.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

409The request conflicts with the current resource state.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

429The credential or source exceeded its rate limit.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

502The cell-local application returned an invalid response.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

503A required cell-local dependency is unavailable.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

Operation IDcreateProjectTemplateOpenAPI JSON ↗

Documentation feedbackWas this page useful?