Create a subscription link

POST/api/v1/mailbox/calendar-subscriptions
Requires amailbox token— it acts as one mailbox holder, not as the organization.

Errors

Status When
401 No token, or the session expired or was signed out. Sign in again with POST /mailbox-auth/login.
403 The account has a temporary password: until POST /security/password succeeds, every other call answers this with error_code: password_change_required.

Request body

  • calendarstring

    Which calendar the link shows (default default).

  • labelstring or null

    A name to tell links apart.

Request

POST/api/v1/mailbox/calendar-subscriptions
curl -X POST 'https://courier.mailyte.com/api/v1/mailbox/calendar-subscriptions' \
  -H 'Authorization: Bearer MAILBOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "calendar": "default",
    "label": "My phone"
  }'

Response

Success.

  • dataobject
    • tokenstring
    • calendar_uristring
    • labelstring or null
    • urlstring
    • webcal_urlstring
    • created_atstring
200application/json
{
  "type": "success",
  "msg": "Subscription link created",
  "data": {
    "token": "s3cr3t-token",
    "calendar_uri": "default",
    "label": "My phone",
    "url": "https://mail.mailyte.com/ics/s3cr3t-token.ics",
    "webcal_url": "webcal://mail.mailyte.com/ics/s3cr3t-token.ics",
    "created_at": "2026-10-11T12:00:00+00:00"
  }
}

Returned inside the standard envelope.

Errors

StatusWhen
401No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`.
403The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`.
422Validation Error

Every status, with what causes it and what to do, is on the error reference.