v1

latestOpenAPI 3.0.12026-07-22120163333.7 KB

Calendar V2 API

Update Calendar Event

Partially updates a Task or Appointment. Only non-empty fields in the request body are applied; omitted fields keep their current values.

Notes:

calendarId must be the composite string returned by POST /v2.0/calendar (e.g. '12345-task' or '12345-appointment'). Invalid format returns 400.
When startAt or endAt is supplied, it must be later than the current server time.

put/v2.0/calendar/{calendarId}

calendarIdstring required

Composite calendar ID returned by POST /v2.0/calendar, of the form '<numericId>-task' or '<numericId>-appointment'.

Authorizationstring required

Bearer [access_token]

Content-Typestring required

application/json

contentstring

Updated content/description

startAtstring

Updated start time in ISO8601 format. Preferred over startAtMs when both are provided.

endAtstring

Updated end time in ISO8601 format. Preferred over endAtMs when both are provided.

startAtMsinteger

Updated start time as Unix timestamp in milliseconds. Used when startAt is not provided.

endAtMsinteger

Updated end time as Unix timestamp in milliseconds. Used when endAt is not provided.

timeZoneCodestring

Updated timezone code

reminderTypestring

Updated reminder type

reminderTimestring

Updated reminder time

leadIdinteger

Updated lead ID

addressstring

Updated address (for APPOINTMENT)

Calendar updated. Response body is a simple message envelope.

messagestring

Result message for the calendar operation.

{
  "message": "Calendar updated successfully"
}