Sign in

v3

latestOpenAPI 3.0.32026-07-21354289.5 KB
File Collections

createUserSchemaFileCollection

Create a new file collection for the current user within a specific schema.

The collection will be private to the creating user and associated with the specified schema.

post/v1/{slug}/collections

Path parameters

slugstring required

The entity schema slug (e.g., order, opportunity, contact)

Request body

namestring required

Name of the collection

parentsstring[]

Array of parent collection slugs, empty array if top-level collection

starredboolean

Whether the collection is starred / favorited

enabled_locationsstring[]

List of location slugs where the collection is enabled. If empty, enabled for all.

enabled_purposesstring[]

List of purpose IDs where the collection is enabled. If empty, enabled for all.

Response

File collection created successfully

slugstring

Full slug for the collection. Format depends on collection type:

  • User collection: _system_files_collection_{entity_uuid}_{user_id}:{collection_name} Example: _system_files_collection_3fa85f64-5717-4562-b3fc-2c963f66afa6_10234:documents
  • Global collection: _system_files_collection_schema_{schema_slug}:{collection_name} Example: _system_files_collection_schema_opportunity:templates
namestring required

Display name of the collection

idstring uuid

Generated uuid for a file collection

parentsstring[]

Array of parent collection slugs, empty array if top-level collection. Format depends on collection type:

  • User collection: _system_files_collection_{entity_uuid}_{user_id} Example: ["_system_files_collection_3fa85f64-5717-4562-b3fc-2c963f66afa6_10234"]
  • Global collection: _system_files_collection_schema_{schema_slug} Example: ["_system_files_collection_schema_opportunity"]
starredboolean

Whether the collection is starred / favorited

ordernumber

Display order for the collection

enabled_locationsstring[]

List of location slugs where the collection is enabled. If empty, enabled for all.

enabled_purposesstring[]

List of purpose slugs where the collection is enabled. If empty, enabled for all.

created_atstring date-time

Timestamp when the collection was created

updated_atstring date-time

Timestamp when the collection was last updated

Example response

{
  "slug": "_system_files_collection_3fa85f64-5717-4562-b3fc-2c963f66afa6_10234:documents",
  "name": "Documents",
  "parents": [
    "_system_files_collection_3fa85f64-5717-4562-b3fc-2c963f66afa6_10234"
  ],
  "enabled_purposes": [
    "9eefcb98-93cf-4c5b-a040-f1d26d57c177",
    "5c544c09-a691-43ed-a7fa-0a8b44b5b161"
  ],
  "created_at": "2024-01-01T12:00:00Z",
  "updated_at": "2024-01-02T12:00:00Z"
}