put/tasks/{id}/planned-workWrite operation

Replace task planned work asynchronously

Atomically compares the strong task schedule revision and accepts a credential-owned asynchronous replacement. The same Idempotency-Key and payload replay the original operation; a different payload conflicts.

Required scopes

planned-work:write

Request example

curl --request PUT \
  --url 'https://api.de.teamgrid.app/v1/tasks/ID/planned-work' \
  --header 'Authorization: Bearer $TEAMGRID_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "dayLoads": [
      0
    ],
    "plannedEnd": "2026-07-29T09:00:00.000Z",
    "plannedStart": "2026-07-29T09:00:00.000Z"
  }'

const response = await fetch('https://api.de.teamgrid.app/v1/tasks/ID/planned-work', {
  method: 'PUT',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "dayLoads": [
    0
  ],
  "plannedEnd": "2026-07-29T09:00:00.000Z",
  "plannedStart": "2026-07-29T09:00:00.000Z"
}),
})

const result = await response.json()

type ApiResponse = unknown

const response = await fetch('https://api.de.teamgrid.app/v1/tasks/ID/planned-work', {
  method: 'PUT',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "dayLoads": [
    0
  ],
  "plannedEnd": "2026-07-29T09:00:00.000Z",
  "plannedStart": "2026-07-29T09:00:00.000Z"
}),
})

const result: ApiResponse = await response.json()

teamgrid tasks planned-work \
  ID \
  --data @payload.json \
  --idempotency-key REQUEST_KEY \
  --if-match REVISION

Example response 2xx

{
  "data": {
    "attributes": {
      "attempts": 0,
      "createdAt": "2026-07-29T09:00:00.000Z",
      "error": {
        "code": "example",
        "message": "string"
      },
      "finishedAt": "2026-07-29T09:00:00.000Z",
      "plannedEnd": "2026-07-29T09:00:00.000Z",
      "plannedStart": "2026-07-29T09:00:00.000Z",
      "projectId": "example",
      "sourceRevision": "example",
      "state": "failed",
      "targetRevision": "example",
      "taskId": "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 strong ETag returned by the latest task planned-work GET. Wildcards, weak validators, and lists 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

dayLoadsrequired

array<number>

The day loads associated with this planned work replacement.

plannedEndrequired

stringdate-time

Planned end timestamp.

plannedStartrequired

stringdate-time

Planned start timestamp.

Responses

202The asynchronous schedule replacement was accepted or replayed.application/json

Response schemaapplication/json

required

PlannedWorkOperation

Public API representation of planned work operation.

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 IDreplaceTaskPlannedWorkOpenAPI JSON ↗

Documentation feedbackWas this page useful?