Skip to content
calternal docs

Update an Event

PUT
/api/v1/calendar/events/{id}
curl --request PUT \
  --url https://example.com/api/v1/calendar/events/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "icalendar": "example" }'

Requires a signed-in User. It replaces the Event on the provider and updates the cached Event. It returns 409 with the latest Event when the provider copy changed. Route: /api/v1/calendar/events/{id}. Inputs: id. Do not automatically replay this operation after an uncertain result.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
icalendar
required
string
Examplegenerated
{
  "icalendar": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
object
event
required
object
all_day
required
boolean
calendar_id
required
string
end
string | null
etag
required
string
id
required
string
location
string | null
start
string | null
summary
required
string
tags
required
Array<string>
timezone
string | null
uid
string | null
updated_at
required
string
icalendar
required
string
Examplegenerated
{
  "event": {
    "all_day": true,
    "calendar_id": "example",
    "end": "example",
    "etag": "example",
    "id": "example",
    "location": "example",
    "start": "example",
    "summary": "example",
    "tags": [
      "example"
    ],
    "timezone": "example",
    "uid": "example",
    "updated_at": "example"
  },
  "icalendar": "example"
}

409

Section titled “409”
Media typeapplication/json
object
error
required

The error object inside the API error envelope.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
latest
required
object
event
required
object
all_day
required
boolean
calendar_id
required
string
end
string | null
etag
required
string
id
required
string
location
string | null
start
string | null
summary
required
string
tags
required
Array<string>
timezone
string | null
uid
string | null
updated_at
required
string
icalendar
required
string
Example
{
  "error": {
    "code": "bad_request"
  }
}

429

Section titled “429”
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}