put/task-recurrences/{id}/occurrences/{occurrenceKey}/overrideWrite operation

Override a task recurrence occurrence

Use this operation to override a task recurrence occurrence. Only documented mutable fields are accepted; omitted fields retain their current values unless the request schema states replacement semantics. Required scopes, product permissions, sharing rules, workspace locks, and regional cell ownership are enforced for every request. Send the latest strong ETag in If-Match; stale revisions fail without overwriting a concurrent change.

Required scopes

task-recurrences:writetasks:readtasks:write

Request example

curl --request PUT \
  --url 'https://api.de.teamgrid.app/v1/task-recurrences/ID/occurrences/OCCURRENCE_KEY/override' \
  --header 'Authorization: Bearer $TEAMGRID_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "action": "materialize",
    "placeholderToken": "example",
    "scheduledForLocal": "example",
    "templatePatch": {
      "billable": false,
      "contactId": "example",
      "customFieldValues": null,
      "description": "string",
      "descriptionFormat": "markdown-v1",
      "groupId": "example",
      "listId": "example",
      "name": "string",
      "personalListId": "example",
      "plannedTime": 0,
      "projectId": "example",
      "serviceId": "example"
    }
  }'

const response = await fetch('https://api.de.teamgrid.app/v1/task-recurrences/ID/occurrences/OCCURRENCE_KEY/override', {
  method: 'PUT',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "action": "materialize",
  "placeholderToken": "example",
  "scheduledForLocal": "example",
  "templatePatch": {
    "billable": false,
    "contactId": "example",
    "customFieldValues": null,
    "description": "string",
    "descriptionFormat": "markdown-v1",
    "groupId": "example",
    "listId": "example",
    "name": "string",
    "personalListId": "example",
    "plannedTime": 0,
    "projectId": "example",
    "serviceId": "example"
  }
}),
})

const result = await response.json()

type ApiResponse = unknown

const response = await fetch('https://api.de.teamgrid.app/v1/task-recurrences/ID/occurrences/OCCURRENCE_KEY/override', {
  method: 'PUT',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "action": "materialize",
  "placeholderToken": "example",
  "scheduledForLocal": "example",
  "templatePatch": {
    "billable": false,
    "contactId": "example",
    "customFieldValues": null,
    "description": "string",
    "descriptionFormat": "markdown-v1",
    "groupId": "example",
    "listId": "example",
    "name": "string",
    "personalListId": "example",
    "plannedTime": 0,
    "projectId": "example",
    "serviceId": "example"
  }
}),
})

const result: ApiResponse = await response.json()

teamgrid task-recurrences override \
  ID \
  --data @payload.json \
  --if-match REVISION

Example response 2xx

{
  "data": {
    "attributes": {
      "attempts": 0,
      "cardId": null,
      "decision": null,
      "definitionVersionId": "string",
      "detachedAt": "2026-07-29T09:00:00.000Z",
      "detachedBy": null,
      "detachedCardId": null,
      "lastErrorCode": null,
      "materializeAt": "2026-07-29T09:00:00.000Z",
      "materializedAt": "2026-07-29T09:00:00.000Z",
      "occurrenceKey": "string",
      "override": null
    },
    "id": "string",
    "type": null
  },
  "meta": {
    "requestId": "string"
  }
}

EndpointGerman region

Interactive request builder

Prepare this request

Build locally · nothing is sent

Region

Credential variable

idpath · requiredoccurrenceKeypath · requiredIf-MatchheaderIf-None-Matchheader

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.

occurrenceKeyrequired

string

Stable occurrence Key used to identify the target within the authenticated workspace.

Headers

If-Match

string

Latest strong occurrence ETag. For placeholder creation omit this header and send If-None-Match: * instead.

If-None-Match

string

Send exactly * to atomically create a future ledger placeholder from a valid stored-preview token. It is mutually exclusive with If-Match.

Request body

application/json

actionrequired

string

Canonical action represented by this record.

materializeskip

placeholderToken

string

The placeholder token associated with this task recurrence occurrence override.

scheduledForLocal

string

The scheduled for local associated with this task recurrence occurrence override.

TaskRecurrenceTemplatePatch

The template patch associated with this task recurrence occurrence override.

Responses

200The authorized recurrence resource.application/json

Response schemaapplication/json

required

TaskRecurrenceOccurrence

Public API representation of task recurrence occurrence.

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

Documentation feedbackWas this page useful?