Skip to content
TeamGrid Developer

Instantiate a project template asynchronously

POST
/project-templates/{id}/instantiate
curl --request POST \
  --url https://api.de.teamgrid.app/v1/project-templates/example/instantiate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: example' \
  --data '{ "additionalContactIds": [ "example" ], "color": "example", "contactId": "example", "description": "example", "dueAt": "2026-04-15T12:00:00Z", "individualId": "example", "listId": "example", "managerId": "example", "name": "example", "plannedEndAt": "2026-04-15T12:00:00Z", "plannedStartAt": "2026-04-15T12:00:00Z", "showInScheduling": true, "subscriberIds": [ "example" ] }'

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.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string
>= 1 characters <= 128 characters

Header Parameters

Section titled “Header Parameters”
Idempotency-Key
required
string
>= 1 characters <= 128 characters /^[!-~]+$/

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

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
additionalContactIds
Array<string> | null
<= 500 items unique items
color
string | null
<= 64 characters
contactId
string | null
>= 1 characters <= 128 characters
description
string
<= 50000 characters
dueAt
string | null format: date-time
individualId
string | null
<= 500 characters
listId
string | null
>= 1 characters <= 128 characters
managerId
string | null
>= 1 characters <= 128 characters
name
required
string
>= 1 characters <= 500 characters
plannedEndAt
string | null format: date-time
plannedStartAt
string | null format: date-time
showInScheduling
boolean | null
subscriberIds
Array<string> | null
<= 500 items unique items
Examplegenerated
{
  "additionalContactIds": [
    "example"
  ],
  "color": "example",
  "contactId": "example",
  "description": "example",
  "dueAt": "2026-04-15T12:00:00Z",
  "individualId": "example",
  "listId": "example",
  "managerId": "example",
  "name": "example",
  "plannedEndAt": "2026-04-15T12:00:00Z",
  "plannedStartAt": "2026-04-15T12:00:00Z",
  "showInScheduling": true,
  "subscriberIds": [
    "example"
  ]
}

Responses

Section titled “Responses”

202

Section titled “202”

The asynchronous template instantiation was accepted.

Media typeapplication/json
object
data
required

Credential-owned asynchronous instantiation status. Checkpoints, source snapshots, generated documents, tenant routing, runner state, and retry internals are never exposed.

object
attributes
required
object
createdAt
required
string format: date-time
error
object
code
required
string
>= 1 characters <= 128 characters
message
required
string
>= 1 characters <= 500 characters
finishedAt
string format: date-time
progress
required
object
listsCompleted
required
integer
<= 100
listsTotal
required
integer
<= 100
tasksCompleted
required
integer
<= 5000
tasksTotal
required
integer
<= 5000
projectId
required
string
>= 1 characters <= 128 characters /^[A-Za-z0-9_-]+$/
state
required
string
Allowed values: failed pending running succeeded
templateId
required
string
>= 1 characters <= 128 characters /^[A-Za-z0-9_-]+$/
updatedAt
required
string format: date-time
id
required
string
>= 1 characters <= 128 characters /^[A-Za-z0-9_-]+$/
type
required
string
Allowed value: projectTemplateInstantiation
meta
required
object
requestId
required
string
Example
{
  "data": {
    "attributes": {
      "state": "failed"
    },
    "type": "projectTemplateInstantiation"
  }
}

Headers

Section titled “Headers”
Idempotency-Replayed
string
Allowed values: false true

Whether this response replays the operation created for this key.

Location
string format: uri-reference

Relative credential-owned polling URL for this operation.

400

Section titled “400”

The request is invalid.

Media typeapplication/json
object
errors
required
Array<object>
object
code
required
string
detail
required
string
source
object
key
additional properties
string
status
required
string
/^[1-5][0-9]{2}$/
title
required
string
meta
required
object
requestId
required
string
Examplegenerated
{
  "errors": [
    {
      "code": "example",
      "detail": "example",
      "source": {
        "additionalProperty": "example"
      },
      "status": "example",
      "title": "example"
    }
  ],
  "meta": {
    "requestId": "example"
  }
}

401

Section titled “401”

The bearer credential is missing, invalid, expired, or revoked.

Media typeapplication/json
object
errors
required
Array<object>
object
code
required
string
detail
required
string
source
object
key
additional properties
string
status
required
string
/^[1-5][0-9]{2}$/
title
required
string
meta
required
object
requestId
required
string
Examplegenerated
{
  "errors": [
    {
      "code": "example",
      "detail": "example",
      "source": {
        "additionalProperty": "example"
      },
      "status": "example",
      "title": "example"
    }
  ],
  "meta": {
    "requestId": "example"
  }
}

403

Section titled “403”

The credential has insufficient scope.

Media typeapplication/json
object
errors
required
Array<object>
object
code
required
string
detail
required
string
source
object
key
additional properties
string
status
required
string
/^[1-5][0-9]{2}$/
title
required
string
meta
required
object
requestId
required
string
Examplegenerated
{
  "errors": [
    {
      "code": "example",
      "detail": "example",
      "source": {
        "additionalProperty": "example"
      },
      "status": "example",
      "title": "example"
    }
  ],
  "meta": {
    "requestId": "example"
  }
}

404

Section titled “404”

The tenant-scoped resource does not exist.

Media typeapplication/json
object
errors
required
Array<object>
object
code
required
string
detail
required
string
source
object
key
additional properties
string
status
required
string
/^[1-5][0-9]{2}$/
title
required
string
meta
required
object
requestId
required
string
Examplegenerated
{
  "errors": [
    {
      "code": "example",
      "detail": "example",
      "source": {
        "additionalProperty": "example"
      },
      "status": "example",
      "title": "example"
    }
  ],
  "meta": {
    "requestId": "example"
  }
}

409

Section titled “409”

The request conflicts with the current resource state.

Media typeapplication/json
object
errors
required
Array<object>
object
code
required
string
detail
required
string
source
object
key
additional properties
string
status
required
string
/^[1-5][0-9]{2}$/
title
required
string
meta
required
object
requestId
required
string
Examplegenerated
{
  "errors": [
    {
      "code": "example",
      "detail": "example",
      "source": {
        "additionalProperty": "example"
      },
      "status": "example",
      "title": "example"
    }
  ],
  "meta": {
    "requestId": "example"
  }
}

429

Section titled “429”

The credential or source exceeded its rate limit.

Media typeapplication/json
object
errors
required
Array<object>
object
code
required
string
detail
required
string
source
object
key
additional properties
string
status
required
string
/^[1-5][0-9]{2}$/
title
required
string
meta
required
object
requestId
required
string
Examplegenerated
{
  "errors": [
    {
      "code": "example",
      "detail": "example",
      "source": {
        "additionalProperty": "example"
      },
      "status": "example",
      "title": "example"
    }
  ],
  "meta": {
    "requestId": "example"
  }
}

Headers

Section titled “Headers”
Retry-After
integer
>= 1

Minimum delay in seconds before retrying.

X-RateLimit-Limit
integer

Maximum requests in the current window.

X-RateLimit-Remaining
integer

Requests remaining in the current window.

X-RateLimit-Reset
integer

Unix time in milliseconds when the current window resets.

X-Request-Id
string

Request correlation identifier.

502

Section titled “502”

The cell-local application returned an invalid response.

Media typeapplication/json
object
errors
required
Array<object>
object
code
required
string
detail
required
string
source
object
key
additional properties
string
status
required
string
/^[1-5][0-9]{2}$/
title
required
string
meta
required
object
requestId
required
string
Examplegenerated
{
  "errors": [
    {
      "code": "example",
      "detail": "example",
      "source": {
        "additionalProperty": "example"
      },
      "status": "example",
      "title": "example"
    }
  ],
  "meta": {
    "requestId": "example"
  }
}

503

Section titled “503”

A required cell-local dependency is unavailable.

Media typeapplication/json
object
errors
required
Array<object>
object
code
required
string
detail
required
string
source
object
key
additional properties
string
status
required
string
/^[1-5][0-9]{2}$/
title
required
string
meta
required
object
requestId
required
string
Examplegenerated
{
  "errors": [
    {
      "code": "example",
      "detail": "example",
      "source": {
        "additionalProperty": "example"
      },
      "status": "example",
      "title": "example"
    }
  ],
  "meta": {
    "requestId": "example"
  }
}