/files

from merge import Merge
from merge.resources.file_storage import FileRequest
client = Merge(
    account_token="YOUR_ACCOUNT_TOKEN",
    api_key="YOUR_API_KEY",
)
client.file_storage.files.create(
    model=FileRequest(),
)

{
  "model": {
    "id": "45ce474c-dhcj-43a6-754r-629f799f7d68",
    "remote_id": "12",
    "created_at": "2021-09-15T00:00:00Z",
    "modified_at": "2021-10-16T00:00:00Z",
    "name": "merge_file_storage_launch.docx",
    "file_url": "https://drive.com/1234",
    "file_thumbnail_url": "https://drive.com/1234/thumbnail.png",
    "size": 254,
    "mime_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
    "description": "Use common model scopes to redact data returned in Merge's Common Models!",
    "folder": "8e889422-e086-42dc-b99e-24d732039b0b",
    "checksum": {
      "type": "sha256",
      "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"
    },
    "permissions": [
      {
        "id": "31ce489c-asdf-68b1-754r-629f799f7123",
        "remote_id": "102895",
        "created_at": "2020-03-31T00:00:00Z",
        "modified_at": "2020-06-20T00:00:00Z",
        "user": "21ce474c-asdf-34a2-754r-629f799f7d12",
        "type": "USER",
        "roles": [
          "OWNER"
        ]
      },
      {
        "id": "2ea7db93-1ae9-4686-82c9-35c768000736",
        "created_at": "2020-03-31T00:00:00Z",
        "modified_at": "2020-06-20T00:00:00Z",
        "group": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type": "GROUP",
        "roles": [
          "READ"
        ]
      }
    ],
    "drive": "204ca79c-0c86-4f6c-9ca6-61b946a4708a",
    "remote_created_at": "2022-02-02T00:00:00Z",
    "remote_updated_at": "2022-02-03T00:00:00Z",
    "remote_was_deleted": true,
    "field_mappings": {
      "organization_defined_targets": {
        "custom_key": "custom_value"
      },
      "linked_account_defined_targets": {
        "custom_key": "custom_value"
      }
    },
    "remote_data": [
      {
        "path": "/files"
      }
    ]
  },
  "warnings": [
    {
      "title": "Unrecognized Field",
      "detail": "An unrecognized field, age, was passed in with request data.",
      "problem_type": "UNRECOGNIZED_FIELD",
      "source": {
        "pointer": "/age"
      },
      "block_merge_link": true
    }
  ],
  "errors": [
    {
      "title": "Missing Required Field",
      "detail": "custom_fields is a required field on model.",
      "problem_type": "MISSING_REQUIRED_FIELD",
      "source": {
        "pointer": "/model/custom_fields"
      },
      "block_merge_link": true
    }
  ],
  "logs": [
    {
      "log_id": "99433219-8017-4acd-bb3c-ceb23d663832",
      "dashboard_view": "https://app.merge.dev/logs/99433219-8017-4acd-bb3c-ceb23d663832",
      "log_summary": {
        "url": "www.exampleintegration.com/api/v1/exampleapi",
        "method": "POST",
        "status_code": 200
      }
    }
  ]
}

Creates a File object with the given values.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Query parameters

is_debug_modebooleanOptional

Whether to include debug fields (such as log file links) in the response.

run_asyncbooleanOptional

Whether or not third-party updates should be run asynchronously.

Request

This endpoint expects an object.

modelobjectRequired

Description

The File object is used to represent a file in the workspace. The Object typically exists under a folder or drive, if it exists.

Usage Example

Fetch from the GET /api/filestorage/v1/files endpoint and view their files.

# The File Object ### Description The `File` object is used to represent a file in the workspace. The Object typically exists under a folder or drive, if it exists. ### Usage Example Fetch from the `GET /api/filestorage/v1/files` endpoint and view their files.

Response

modelobject

Description

The File object is used to represent a file in the workspace. The Object typically exists under a folder or drive, if it exists.

Usage Example

Fetch from the GET /api/filestorage/v1/files endpoint and view their files.

warningslist of objects

errorslist of objects

logslist of objects or null

Supported POST model parameters

namestring or nullRequired<=254 characters

The file's name.

file_urlstring or nullRequired<=2000 characters

The URL to access the file.

remote_idstring or nullOptional

The third-party API ID of the matching object.

sizelong or nullOptional-9223372036854776000-9223372036854776000

The file's size, in bytes.

mime_typestring or nullOptional<=128 characters

The file's mime type.

descriptionstring or nullOptional<=2000 characters

The file's description.

folderstring or nullOptionalformat: "uuid"

The folder that the file belongs to.

permissionslist of objectsOptional

remote_created_atdatetime or nullOptional

When the third party's file was created.

remote_updated_atdatetime or nullOptional

When the third party's file was updated.

Supported POST model parameters

namestring or nullRequired<=254 characters

The file's name.

file_urlstring or nullRequired<=2000 characters

The URL to access the file.

remote_idstring or nullOptional

The third-party API ID of the matching object.

sizelong or nullOptional-9223372036854776000-9223372036854776000

The file's size, in bytes.

mime_typestring or nullOptional<=128 characters

The file's mime type.

folderstring or nullOptionalformat: "uuid"

The folder that the file belongs to.

remote_updated_atdatetime or nullOptional

When the third party's file was updated.

Supported POST model parameters

namestring or nullRequired<=254 characters

The file's name.

file_urlstring or nullRequired<=2000 characters

The URL to access the file.

mime_typestring or nullRequired<=128 characters

The file's mime type.

remote_idstring or nullOptional

The third-party API ID of the matching object.

file_thumbnail_urlstring or nullOptional<=2000 characters

The URL that produces a thumbnail preview of the file. Typically an image.

sizelong or nullOptional-9223372036854776000-9223372036854776000

The file's size, in bytes.

folderstring or nullOptionalformat: "uuid"

The folder that the file belongs to.

checksummap from strings to any or nullOptional

This field stores file checksum data. ‘type’ indicates the algorithm (e.g. crc_32, sha1, sha256, quickXor, or md5), and ‘content_hash’ is the unique hash used to verify file integrity and detect alterations.

permissionslist of objectsOptional

drivestring or nullOptionalformat: "uuid"

The drive that the file belongs to.

remote_created_atdatetime or nullOptional

When the third party's file was created.

remote_updated_atdatetime or nullOptional

When the third party's file was updated.

Supported POST model parameters

namestring or nullRequired<=254 characters

The file's name.

file_urlstring or nullRequired<=2000 characters

The URL to access the file.

mime_typestring or nullRequired<=128 characters

The file's mime type.

remote_idstring or nullOptional

The third-party API ID of the matching object.

sizelong or nullOptional-9223372036854776000-9223372036854776000

The file's size, in bytes.

folderstring or nullOptionalformat: "uuid"

The folder that the file belongs to.

permissionslist of objectsOptional

drivestring or nullOptionalformat: "uuid"

The drive that the file belongs to.

remote_created_atdatetime or nullOptional

When the third party's file was created.

remote_updated_atdatetime or nullOptional

When the third party's file was updated.

Supported POST model parameters

namestring or nullRequired<=254 characters

The file's name.

file_urlstring or nullRequired<=2000 characters

The URL to access the file.

mime_typestring or nullRequired<=128 characters

The file's mime type.

drivestring or nullRequiredformat: "uuid"

The drive that the file belongs to.

remote_idstring or nullOptional

The third-party API ID of the matching object.

sizelong or nullOptional-9223372036854776000-9223372036854776000

The file's size, in bytes.

folderstring or nullOptionalformat: "uuid"

The folder that the file belongs to.

checksummap from strings to any or nullOptional

permissionslist of objectsOptional

remote_created_atdatetime or nullOptional

When the third party's file was created.

remote_updated_atdatetime or nullOptional

When the third party's file was updated.

Supported POST model parameters

namestring or nullRequired<=254 characters

The file's name.

file_urlstring or nullRequired<=2000 characters

The URL to access the file.

remote_idstring or nullOptional

The third-party API ID of the matching object.

sizelong or nullOptional-9223372036854776000-9223372036854776000

The file's size, in bytes.

mime_typestring or nullOptional<=128 characters

The file's mime type.

descriptionstring or nullOptional<=2000 characters

The file's description.

folderstring or nullOptionalformat: "uuid"

The folder that the file belongs to.

permissionslist of objectsOptional

remote_created_atdatetime or nullOptional

When the third party's file was created.

remote_updated_atdatetime or nullOptional

When the third party's file was updated.

Supported POST model parameters

namestring or nullRequired<=254 characters

The file's name.

file_urlstring or nullRequired<=2000 characters

The URL to access the file.

remote_idstring or nullOptional

The third-party API ID of the matching object.

sizelong or nullOptional-9223372036854776000-9223372036854776000

The file's size, in bytes.

mime_typestring or nullOptional<=128 characters

The file's mime type.

folderstring or nullOptionalformat: "uuid"

The folder that the file belongs to.

remote_updated_atdatetime or nullOptional

When the third party's file was updated.

Supported POST model parameters

namestring or nullRequired<=254 characters

The file's name.

file_urlstring or nullRequired<=2000 characters

The URL to access the file.

mime_typestring or nullRequired<=128 characters

The file's mime type.

remote_idstring or nullOptional

The third-party API ID of the matching object.

file_thumbnail_urlstring or nullOptional<=2000 characters

The URL that produces a thumbnail preview of the file. Typically an image.

sizelong or nullOptional-9223372036854776000-9223372036854776000

The file's size, in bytes.

folderstring or nullOptionalformat: "uuid"

The folder that the file belongs to.

checksummap from strings to any or nullOptional

permissionslist of objectsOptional

drivestring or nullOptionalformat: "uuid"

The drive that the file belongs to.

remote_created_atdatetime or nullOptional

When the third party's file was created.

remote_updated_atdatetime or nullOptional

When the third party's file was updated.

Supported POST model parameters

namestring or nullRequired<=254 characters

The file's name.

file_urlstring or nullRequired<=2000 characters

The URL to access the file.

mime_typestring or nullRequired<=128 characters

The file's mime type.

remote_idstring or nullOptional

The third-party API ID of the matching object.

sizelong or nullOptional-9223372036854776000-9223372036854776000

The file's size, in bytes.

folderstring or nullOptionalformat: "uuid"

The folder that the file belongs to.

permissionslist of objectsOptional

drivestring or nullOptionalformat: "uuid"

The drive that the file belongs to.

remote_created_atdatetime or nullOptional

When the third party's file was created.

remote_updated_atdatetime or nullOptional

When the third party's file was updated.

Supported POST model parameters

namestring or nullRequired<=254 characters

The file's name.

file_urlstring or nullRequired<=2000 characters

The URL to access the file.

mime_typestring or nullRequired<=128 characters

The file's mime type.

drivestring or nullRequiredformat: "uuid"

The drive that the file belongs to.

remote_idstring or nullOptional

The third-party API ID of the matching object.

sizelong or nullOptional-9223372036854776000-9223372036854776000

The file's size, in bytes.

folderstring or nullOptionalformat: "uuid"

The folder that the file belongs to.

checksummap from strings to any or nullOptional

permissionslist of objectsOptional

remote_created_atdatetime or nullOptional

When the third party's file was created.

remote_updated_atdatetime or nullOptional

When the third party's file was updated.

Authentication

Headers

Query parameters

Request

Description

Usage Example

Response

Description

Usage Example

Field support by integration

Description

Usage Example

Description

Usage Example

Field support by integration