Skip to content
Sursa Developers

Objects

SourceCreate

Fields

  • kindstring

    Source kind (see SourceKind); with an organization API key, only custom.

    Default: "gdrive"

  • namestringrequired

    length ≥ 1, length ≤ 120

  • collectionstring

    Name of the source's collection; you can pass collection_id instead (since 1.62.0).

    length ≥ 1, length ≤ 64

  • collection_idinteger

    Collection of the source by ID (since 1.62.0); if both are passed, collection_id wins.

  • permissions_modestring

    Permission mode of the source's cards (since 1.62.0, as in update_source_settings): own uses the collection's permissions, mirror takes them from the document (permissions). Choosing mirror requires the right to manage the collection's permissions.

    Allowed values: ownmirror

  • default_owner_idinteger | null
  • verify_interval_daysinteger

    Default: 90≥ 1, ≤ 3650

  • tagsarray of string

    Default: []

  • default_categorystring | null
  • rootsarray of string | null

    Selected folders of the source: only items inside them become cards. For a custom source, the folder paths of documents (Guides/Billing); for connectors, nodes of the provider's tree.

  • folder_idstring | null

    Folder in the source's collection where cards are placed (null means the collection root).

  • folder_modestring

    flat puts everything in the selected folder; mirror creates folders that repeat the item's path in the source, no deeper than the folder nesting limit (3 levels; deeper items go to the nearest folder).

    Allowed values: flatmirror

    Default: "flat"

Used by