SapanCalDeveloper Docs

Create or update an event

Writes an event to the user's calendar under your own event_id. The first write creates it; later writes with the same id update it, so retries are safe.

It goes to the default connection's primary calendar unless connection_id or calendar_id says otherwise. If a later write targets a different calendar, the event moves. If the event was deleted at the provider, it is created again.

PUThttps://api.bentocal.com/au/v1/users/{user_id}/events/{event_id}

Authentication

AuthorizationstringheaderBearer <token>required

An API key: bc_{live|test}_{region}_…, from the console.

Path parameters

2 params
  • user_idstringlength: 1…255required

    Your identifier for the end user. URL-encode it.

  • event_idstringlength: 1…255required

    Your own identifier for the event (for example your booking id). URL-encode it.

Request body

application/jsonrequired
  • summarystringlength: 1…1024required

    Event title.

  • descriptionstringlength: 0…8192
  • startstringdate-timerequired
  • endstringdate-timerequired

    Must be after start.

  • time_zonestringlength: 0…64

    IANA time zone for the event, e.g. Australia/Sydney.

  • locationstringlength: 0…1024
  • all_daybooleandefault: false
  • connection_idstring

    Write to this connection instead of the user's default connection.

  • calendar_idstring

    Write to this calendar instead of the connection's primary calendar.

  • transparencystringdefault: opaqueopaque | transparent

    opaque blocks time in free/busy; transparent does not.

Responses

The link between your event id and the provider's event.

  • event_idstringrequired

    Your event id from the path.

  • connection_idstringrequired

    The connection the event was written to.

  • calendar_idstringrequired

    The calendar the event was written to.

  • provider_event_idstringrequired

    The provider's id for the event.

Errors