Skip to content
calternal docs

Update a published Calendar feed

PUT
/api/v1/calendar/feeds/{id}
curl --request PUT \
  --url https://example.com/api/v1/calendar/feeds/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "color": "example", "detail": "full", "include_notes": true, "include_tasks": true, "name": "example", "source": "journal", "source_id": "example" }'

Requires a signed-in User. It changes the feed name, source or display settings and keeps the current link. It returns 404 when the feed is missing. Route: /api/v1/calendar/feeds/{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

Input for changing a feed’s human-readable options and data source.

object
color
string | null
detail
required

Full feeds keep event details; Busy-only feeds reveal only availability.

string
Allowed values: full busy_only
include_notes
boolean
include_tasks
boolean
name
required
string
source
required

A feed source selects one owner-scoped collection of calendar data.

string
Allowed values: journal area calendar
source_id
string | null

Responses

Section titled “Responses”

204

Section titled “204”

404

Section titled “404”
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"
  }
}