Skip to content
calternal docs

Update a Calendar subscription

PUT
/api/v1/calendar/subscriptions/{id}
curl --request PUT \
  --url https://example.com/api/v1/calendar/subscriptions/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "color": "example", "name": "example", "visible": true }'

Requires a signed-in User. It changes the subscription name, colour or visibility. It returns 404 when the subscription is missing. Route: /api/v1/calendar/subscriptions/{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
color
string | null
name
string | null
visible
boolean | null
Examplegenerated
{
  "color": "example",
  "name": "example",
  "visible": true
}

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
object
color
required
string
id
required
string
last_error
string | null
name
required
string
refresh_after_ms
integer | null format: int64
refreshed_ms
integer | null format: int64
url
required
string
visible
required
boolean
Examplegenerated
{
  "color": "example",
  "id": "example",
  "last_error": "example",
  "name": "example",
  "refresh_after_ms": 1,
  "refreshed_ms": 1,
  "url": "example",
  "visible": true
}

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"
  }
}