patch/appointments/{id}Write operation

Update a TeamGrid-managed appointment

Requires the latest strong resource ETag. The cell-local App re-authenticates and atomically applies the tenant-bound revision before returning a fresh ETag.

Required scopes

appointments:write

Conditional scopes

appointments:delegated:write

Request example

curl --request PATCH \
  --url 'https://api.de.teamgrid.app/v1/appointments/ID' \
  --header 'Authorization: Bearer $TEAMGRID_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "allDay": false,
    "busy": false,
    "description": "string",
    "end": {
      "at": "2026-07-29T09:00:00.000Z",
      "timeZone": "string"
    },
    "location": "string",
    "start": {
      "at": "2026-07-29T09:00:00.000Z",
      "timeZone": "string"
    },
    "title": "string",
    "visibility": "default"
  }'

const response = await fetch('https://api.de.teamgrid.app/v1/appointments/ID', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "allDay": false,
  "busy": false,
  "description": "string",
  "end": {
    "at": "2026-07-29T09:00:00.000Z",
    "timeZone": "string"
  },
  "location": "string",
  "start": {
    "at": "2026-07-29T09:00:00.000Z",
    "timeZone": "string"
  },
  "title": "string",
  "visibility": "default"
}),
})

const result = await response.json()

type ApiResponse = unknown

const response = await fetch('https://api.de.teamgrid.app/v1/appointments/ID', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "allDay": false,
  "busy": false,
  "description": "string",
  "end": {
    "at": "2026-07-29T09:00:00.000Z",
    "timeZone": "string"
  },
  "location": "string",
  "start": {
    "at": "2026-07-29T09:00:00.000Z",
    "timeZone": "string"
  },
  "title": "string",
  "visibility": "default"
}),
})

const result: ApiResponse = await response.json()

teamgrid appointments update \
  ID \
  --data @payload.json \
  --if-match REVISION

Example response 2xx

{
  "data": {
    "attributes": {
      "allDay": false,
      "archived": false,
      "busy": false,
      "createdAt": "2026-07-29T09:00:00.000Z",
      "description": null,
      "end": {
        "at": "2026-07-29T09:00:00.000Z",
        "timeZone": null
      },
      "location": null,
      "managedBy": "provider",
      "redacted": false,
      "revision": "example",
      "start": {
        "at": "2026-07-29T09:00:00.000Z",
        "timeZone": null
      },
      "title": 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 · requiredIf-Matchheader · 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 appointment ETag. Wildcards, weak validators, and lists are rejected.

Request body

application/json

allDay

boolean

Whether all day applies to this appointment.

busy

boolean

Whether busy applies to this appointment.

description

string

Human-readable description of the resource.

object

End timestamp of the represented interval.

location

string

The location associated with this appointment.

object

Start timestamp of the represented interval.

title

string

Human-readable title of the resource.

visibility

string

Canonical visibility value for this appointment.

defaultprivatepublic

Responses

200The request to update a TeamGrid-managed appointment succeeded. The response contains the canonical public result and request metadata.application/json

Response schemaapplication/json

required

Appointment

Public API representation of appointment.

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

Documentation feedbackWas this page useful?