/files

curl -X POST https://api.merge.dev/api/filestorage/v1/files \
     -H "X-Account-Token: X-Account-Token" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "model": {}
}'

{
  "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,
      "raw_error": "string",
      "error_code": 1
    }
  ],
  "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,
      "raw_error": "string",
      "error_code": 1
    }
  ],
  "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

Authentication

Headers

Query parameters

Request

Description

Usage Example

Response

Description

Usage Example

Field support by integration

Description

Usage Example

Description

Usage Example