post/project-templates/{id}/instantiateWrite operation

Instantiate a project template asynchronously

The cell-local App re-authenticates the credential, verifies both required scopes, tenant ownership, projects.templates and projects.create plan permissions, validates every referenced resource, and starts a credential-owned asynchronous operation.

Required scopes

project-templates:writeprojects:write

Request example

curl --request POST \
  --url 'https://api.de.teamgrid.app/v1/project-templates/ID/instantiate' \
  --header 'Authorization: Bearer $TEAMGRID_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "additionalContactIds": null,
    "color": null,
    "contactId": null,
    "description": "string",
    "dueAt": "2026-07-29T09:00:00.000Z",
    "individualId": null,
    "listId": null,
    "managerId": null,
    "name": "string",
    "plannedEndAt": "2026-07-29T09:00:00.000Z",
    "plannedStartAt": "2026-07-29T09:00:00.000Z",
    "showInScheduling": null
  }'

const response = await fetch('https://api.de.teamgrid.app/v1/project-templates/ID/instantiate', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "additionalContactIds": null,
  "color": null,
  "contactId": null,
  "description": "string",
  "dueAt": "2026-07-29T09:00:00.000Z",
  "individualId": null,
  "listId": null,
  "managerId": null,
  "name": "string",
  "plannedEndAt": "2026-07-29T09:00:00.000Z",
  "plannedStartAt": "2026-07-29T09:00:00.000Z",
  "showInScheduling": null
}),
})

const result = await response.json()

type ApiResponse = unknown

const response = await fetch('https://api.de.teamgrid.app/v1/project-templates/ID/instantiate', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "additionalContactIds": null,
  "color": null,
  "contactId": null,
  "description": "string",
  "dueAt": "2026-07-29T09:00:00.000Z",
  "individualId": null,
  "listId": null,
  "managerId": null,
  "name": "string",
  "plannedEndAt": "2026-07-29T09:00:00.000Z",
  "plannedStartAt": "2026-07-29T09:00:00.000Z",
  "showInScheduling": null
}),
})

const result: ApiResponse = await response.json()

teamgrid project-templates instantiate \
  ID \
  --data @payload.json \
  --idempotency-key REQUEST_KEY \
  --if-match REVISION

Example response 2xx

{
  "data": {
    "attributes": {
      "createdAt": "2026-07-29T09:00:00.000Z",
      "error": {
        "code": "string",
        "message": "string"
      },
      "finishedAt": "2026-07-29T09:00:00.000Z",
      "progress": {
        "listsCompleted": 0,
        "listsTotal": 0,
        "tasksCompleted": 0,
        "tasksTotal": 0
      },
      "projectId": "example",
      "resultRevision": null,
      "sourceRevision": "example",
      "state": "failed",
      "templateId": "example",
      "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

idpath · requiredIf-Matchheader · requiredIdempotency-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.

Path parameters

idrequired

string

Stable identifier of the resource in the authenticated workspace.

Headers

If-Matchrequired

string

Exactly one latest strong project-template ETag. Wildcards, weak validators, lists, and surrounding whitespace are rejected.

Idempotency-Keyrequired

string

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

Request body

application/json

additionalContactIds

arraynullable

Ordered set of additional contact identifiers associated with this project template instantiate.

color

stringnullable

Canonical color value used to display the resource.

contactId

stringnullable

Identifier of the related contact.

description

string

Human-readable description of the resource.

dueAt

stringdate-timenullable

ISO 8601 timestamp for due at.

individualId

stringnullable

The individual id associated with this project template instantiate.

listId

stringnullable

Identifier of the related task list.

managerId

stringnullable

The manager id associated with this project template instantiate.

namerequired

string

Human-readable name of the resource.

plannedEndAt

stringdate-timenullable

ISO 8601 timestamp for planned end at.

plannedStartAt

stringdate-timenullable

ISO 8601 timestamp for planned start at.

showInScheduling

booleannullable

The show in scheduling associated with this project template instantiate.

subscriberIds

arraynullable

Ordered set of subscriber identifiers associated with this project template instantiate.

Responses

202The asynchronous template instantiation was accepted.application/json

Response schemaapplication/json

required

ProjectTemplateInstantiation

Credential-owned asynchronous instantiation status. Checkpoints, source snapshots, generated documents, tenant routing, runner state, and retry 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.

404The tenant-scoped resource does not exist.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.

412The resource changed since the supplied revision.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.

428A strong If-Match revision is required.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 IDinstantiateProjectTemplateOpenAPI JSON ↗

Documentation feedbackWas this page useful?