Sign in
calendarChannels

Update One calendarChannel

patch/calendarChannels/{id}

Request

  • Base URL: https://twenty.mardu.systems/rest
  • URL: https://twenty.mardu.systems/rest/calendarChannels/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Object id.

Query parameters

depth0 | 1

Determines the level of nested related objects to include in the response. - 0: Primary object only - 1: Primary object + direct relations

Request body

handlestring

Handle

visibility'METADATA' | 'SHARE_EVERYTHING'

Visibility

isContactAutoCreationEnabledboolean

Is Contact Auto Creation Enabled

contactAutoCreationPolicy'AS_PARTICIPANT_AND_ORGANIZER' | 'AS_PARTICIPANT' | 'AS_ORGANIZER' | 'NONE'

Automatically create records for people you participated with in an event.

isSyncEnabledboolean

Is Sync Enabled

syncCursorstring

Sync Cursor. Used for syncing events from the calendar provider

syncStatus'ONGOING' | 'NOT_SYNCED' | 'ACTIVE' | 'FAILED_INSUFFICIENT_PERMISSIONS' | 'FAILED_UNKNOWN'

Sync status

syncStage'CALENDAR_EVENT_LIST_FETCH_PENDING' | 'CALENDAR_EVENT_LIST_FETCH_SCHEDULED' | 'CALENDAR_EVENT_LIST_FETCH_ONGOING' | 'CALENDAR_EVENTS_IMPORT_PENDING' | 'CALENDAR_EVENTS_IMPORT_SCHEDULED' | 'CALENDAR_EVENTS_IMPORT_ONGOING' | 'FAILED' | 'PENDING_CONFIGURATION'

Sync stage

syncStageStartedAtstring date-time

Sync stage started at

syncedAtstring date-time

Last sync date

throttleFailureCountinteger

Throttle Failure Count

connectedAccountIdstring uuid

Example request

{
  "visibility": "METADATA",
  "contactAutoCreationPolicy": "AS_PARTICIPANT_AND_ORGANIZER",
  "syncStatus": "ONGOING",
  "syncStage": "CALENDAR_EVENT_LIST_FETCH_PENDING",
  "connectedAccount": null,
  "calendarChannelEventAssociations": null
}

Response

Successful operation

Changes

No recorded changes to this operation across all 1 revision of this API.