patch/time-entries/{id}Write operation

Update a time entry

Use this operation to update a time entry. 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.

Required scopes

time-entries:write

Request example

curl --request PATCH \
  --url 'https://api.de.teamgrid.app/v1/time-entries/ID' \
  --header 'Authorization: Bearer $TEAMGRID_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "billable": null,
    "comment": null,
    "endAt": "2026-07-29T09:00:00.000Z",
    "serviceId": null,
    "startAt": "2026-07-29T09:00:00.000Z"
  }'

const response = await fetch('https://api.de.teamgrid.app/v1/time-entries/ID', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "billable": null,
  "comment": null,
  "endAt": "2026-07-29T09:00:00.000Z",
  "serviceId": null,
  "startAt": "2026-07-29T09:00:00.000Z"
}),
})

const result = await response.json()

type ApiResponse = unknown

const response = await fetch('https://api.de.teamgrid.app/v1/time-entries/ID', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "billable": null,
  "comment": null,
  "endAt": "2026-07-29T09:00:00.000Z",
  "serviceId": null,
  "startAt": "2026-07-29T09:00:00.000Z"
}),
})

const result: ApiResponse = await response.json()

teamgrid time-entries update \
  ID \
  --data @payload.json

Example response 2xx

{
  "data": {
    "attributes": {
      "archived": false,
      "billable": null,
      "billed": false,
      "billedAt": "2026-07-29T09:00:00.000Z",
      "comment": "string",
      "createdAt": "2026-07-29T09:00:00.000Z",
      "createdById": null,
      "durationMinutes": null,
      "endAt": "2026-07-29T09:00:00.000Z",
      "serviceId": null,
      "startAt": "2026-07-29T09:00:00.000Z",
      "taskId": "string"
    },
    "id": "string",
    "type": null
  },
  "meta": {
    "requestId": "string"
  }
}

EndpointGerman region

Interactive request builder

Prepare this request

Build locally · nothing is sent

Region

Credential variable

idpath · 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.

Request body

application/json

billable

booleannullable

Whether this time or service can be billed.

comment

stringnullable

The comment associated with this time entry.

endAt

stringdate-timenullable

ISO 8601 timestamp for end at.

serviceId

stringnullable

Identifier of the related service.

startAt

stringdate-timenullable

ISO 8601 timestamp for start at.

Responses

200The request to update a time entry succeeded. The response contains the canonical public result and request metadata.application/json

Response schemaapplication/json

required

TimeEntry

Public API representation of time entry.

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.

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

Documentation feedbackWas this page useful?