Skip to content
XOS Developers

Create a personal calendar feed

Platform module

POST/person-calendar-feedspersonCalendarFeeds.create

Creates the caller's own feed across every org they work with (app.create_person_calendar_feed) and returns its token once. At most 20 live feeds (calendar_feed_limit: 422). Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.

  • Requires the capability me.calendar_feeds.write.
  • OAuth scopes: me.
  • Send an Idempotency-Key header. A replay with the same key returns the original response.
  • Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Response 201: CalendarFeedToken

personCalendarFeeds.create: CalendarFeedToken
FieldTypeRequiredDescription
calendar_feed_idstring (uuid)YesIdentifier of the calendar feed.
feed_tokenstringYesThe token of the feed's subscription URL. Shown once; only its hash is stored, and revoking the feed ends it.Constraints: length 1 to any
{
  "calendar_feed_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "feed_token": "cal_9fQ2mX4vT7kL1pR8"
}

Code samples

curl -X POST "$XOS_BASE_URL/person-calendar-feeds" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"
const { data } = await xos.personCalendarFeeds.create();
response = xos.person_calendar_feeds.create()
xos person-calendar-feeds create