Skip to content
calternal docs

Subscribe to a Calendar feed

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

Requires a signed-in User. It checks and fetches the feed before it saves the subscription. It returns 400 for an invalid source or 413 when the feed is too large. Route: /api/v1/calendar/subscriptions. Inputs: . Do not automatically replay this operation after an uncertain result.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
color
string | null
name
required
string
url
required
string
Examplegenerated
{
  "color": "example",
  "name": "example",
  "url": "example"
}

Responses

Section titled “Responses”

201

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

400

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

413

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