Move a file synchronously

curl --request POST \
  --url https://eu.phrase.com/connectors/google-drive/v1/sync/move-file \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "connectorUuid": "4282fec0-d2e9-4266-8733-3e634feb7b59",
  "configuration": {},
  "source": {
    "pathType": "FILE",
    "fileId": "1A2b3C4d5E6f7G8h9I0jK",
    "name": "report.pdf",
    "drive": {
      "driveType": "MY_DRIVE"
    },
    "parentChain": [
      {
        "id": "root",
        "name": "My Drive"
      },
      {
        "id": "0B7_inbox",
        "name": "inbox"
      }
    ]
  },
  "destination": {
    "pathType": "FOLDER",
    "name": "processed",
    "drive": {
      "driveType": "MY_DRIVE"
    },
    "parentChain": [
      {
        "id": "root",
        "name": "My Drive"
      },
      {
        "id": "0B7_inbox",
        "name": "inbox"
      }
    ]
  }
}
'

import requests

url = "https://eu.phrase.com/connectors/google-drive/v1/sync/move-file"

payload = {
    "connectorUuid": "4282fec0-d2e9-4266-8733-3e634feb7b59",
    "configuration": {},
    "source": {
        "pathType": "FILE",
        "fileId": "1A2b3C4d5E6f7G8h9I0jK",
        "name": "report.pdf",
        "drive": { "driveType": "MY_DRIVE" },
        "parentChain": [
            {
                "id": "root",
                "name": "My Drive"
            },
            {
                "id": "0B7_inbox",
                "name": "inbox"
            }
        ]
    },
    "destination": {
        "pathType": "FOLDER",
        "name": "processed",
        "drive": { "driveType": "MY_DRIVE" },
        "parentChain": [
            {
                "id": "root",
                "name": "My Drive"
            },
            {
                "id": "0B7_inbox",
                "name": "inbox"
            }
        ]
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    connectorUuid: '4282fec0-d2e9-4266-8733-3e634feb7b59',
    configuration: {},
    source: {
      pathType: 'FILE',
      fileId: '1A2b3C4d5E6f7G8h9I0jK',
      name: 'report.pdf',
      drive: {driveType: 'MY_DRIVE'},
      parentChain: [{id: 'root', name: 'My Drive'}, {id: '0B7_inbox', name: 'inbox'}]
    },
    destination: {
      pathType: 'FOLDER',
      name: 'processed',
      drive: {driveType: 'MY_DRIVE'},
      parentChain: [{id: 'root', name: 'My Drive'}, {id: '0B7_inbox', name: 'inbox'}]
    }
  })
};

fetch('https://eu.phrase.com/connectors/google-drive/v1/sync/move-file', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://eu.phrase.com/connectors/google-drive/v1/sync/move-file",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'connectorUuid' => '4282fec0-d2e9-4266-8733-3e634feb7b59',
    'configuration' => [
        
    ],
    'source' => [
        'pathType' => 'FILE',
        'fileId' => '1A2b3C4d5E6f7G8h9I0jK',
        'name' => 'report.pdf',
        'drive' => [
                'driveType' => 'MY_DRIVE'
        ],
        'parentChain' => [
                [
                                'id' => 'root',
                                'name' => 'My Drive'
                ],
                [
                                'id' => '0B7_inbox',
                                'name' => 'inbox'
                ]
        ]
    ],
    'destination' => [
        'pathType' => 'FOLDER',
        'name' => 'processed',
        'drive' => [
                'driveType' => 'MY_DRIVE'
        ],
        'parentChain' => [
                [
                                'id' => 'root',
                                'name' => 'My Drive'
                ],
                [
                                'id' => '0B7_inbox',
                                'name' => 'inbox'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://eu.phrase.com/connectors/google-drive/v1/sync/move-file"

	payload := strings.NewReader("{\n  \"connectorUuid\": \"4282fec0-d2e9-4266-8733-3e634feb7b59\",\n  \"configuration\": {},\n  \"source\": {\n    \"pathType\": \"FILE\",\n    \"fileId\": \"1A2b3C4d5E6f7G8h9I0jK\",\n    \"name\": \"report.pdf\",\n    \"drive\": {\n      \"driveType\": \"MY_DRIVE\"\n    },\n    \"parentChain\": [\n      {\n        \"id\": \"root\",\n        \"name\": \"My Drive\"\n      },\n      {\n        \"id\": \"0B7_inbox\",\n        \"name\": \"inbox\"\n      }\n    ]\n  },\n  \"destination\": {\n    \"pathType\": \"FOLDER\",\n    \"name\": \"processed\",\n    \"drive\": {\n      \"driveType\": \"MY_DRIVE\"\n    },\n    \"parentChain\": [\n      {\n        \"id\": \"root\",\n        \"name\": \"My Drive\"\n      },\n      {\n        \"id\": \"0B7_inbox\",\n        \"name\": \"inbox\"\n      }\n    ]\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://eu.phrase.com/connectors/google-drive/v1/sync/move-file")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"connectorUuid\": \"4282fec0-d2e9-4266-8733-3e634feb7b59\",\n  \"configuration\": {},\n  \"source\": {\n    \"pathType\": \"FILE\",\n    \"fileId\": \"1A2b3C4d5E6f7G8h9I0jK\",\n    \"name\": \"report.pdf\",\n    \"drive\": {\n      \"driveType\": \"MY_DRIVE\"\n    },\n    \"parentChain\": [\n      {\n        \"id\": \"root\",\n        \"name\": \"My Drive\"\n      },\n      {\n        \"id\": \"0B7_inbox\",\n        \"name\": \"inbox\"\n      }\n    ]\n  },\n  \"destination\": {\n    \"pathType\": \"FOLDER\",\n    \"name\": \"processed\",\n    \"drive\": {\n      \"driveType\": \"MY_DRIVE\"\n    },\n    \"parentChain\": [\n      {\n        \"id\": \"root\",\n        \"name\": \"My Drive\"\n      },\n      {\n        \"id\": \"0B7_inbox\",\n        \"name\": \"inbox\"\n      }\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://eu.phrase.com/connectors/google-drive/v1/sync/move-file")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"connectorUuid\": \"4282fec0-d2e9-4266-8733-3e634feb7b59\",\n  \"configuration\": {},\n  \"source\": {\n    \"pathType\": \"FILE\",\n    \"fileId\": \"1A2b3C4d5E6f7G8h9I0jK\",\n    \"name\": \"report.pdf\",\n    \"drive\": {\n      \"driveType\": \"MY_DRIVE\"\n    },\n    \"parentChain\": [\n      {\n        \"id\": \"root\",\n        \"name\": \"My Drive\"\n      },\n      {\n        \"id\": \"0B7_inbox\",\n        \"name\": \"inbox\"\n      }\n    ]\n  },\n  \"destination\": {\n    \"pathType\": \"FOLDER\",\n    \"name\": \"processed\",\n    \"drive\": {\n      \"driveType\": \"MY_DRIVE\"\n    },\n    \"parentChain\": [\n      {\n        \"id\": \"root\",\n        \"name\": \"My Drive\"\n      },\n      {\n        \"id\": \"0B7_inbox\",\n        \"name\": \"inbox\"\n      }\n    ]\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "pathType": "FILE",
  "fileId": "1A2b3C4d5E6f7G8h9I0jK",
  "name": "report.pdf",
  "drive": {
    "driveType": "MY_DRIVE"
  },
  "parentChain": [
    {
      "id": "root",
      "name": "My Drive"
    },
    {
      "id": "0B7_inbox",
      "name": "inbox"
    },
    {
      "id": "0B7_processed",
      "name": "processed"
    }
  ]
}

""

Google Drive

Move a file synchronously

Move one file to another folder in Google Drive. This is a strict relocation: the same file (same fileId, same name) ends up in the destination folder. It is never replaced by a copy or an upload, and no other file is overwritten, replaced or deleted. A file with the same name that is already in the destination does not block the move.

Source. source is the file together with where you expect it to be: the last element of source.parentChain is its direct parent (with an id, as returned by list-files; an empty chain means the drive root). Only that parent is removed.

Destination. destination is a folder. With folderId that folder is used. Without it, name is required and the folder is resolved like the target of upload-raw-file: parents with an id are used, named parents are looked up by name, and a missing named folder is created, but only when the file is actually going to be moved. With several folders of the same name, the oldest (creation time, then id) is used.

Scope. Files only, within My Drive or within one shared drive. A folder as the source or a destination in another drive is rejected with MOVE_UNSUPPORTED before anything is changed.

Outcomes.

The file is in the expected parent: it is moved. The response is its new path.
The file is already in the destination, or source and destination are the same folder: the request succeeds without any change and returns the current path.
The file is somewhere else: MOVE_SOURCE_NOT_AT_EXPECTED_LOCATION, nothing is changed and no folder is created.

Errors. Failures use the common error model. These errorCode values are stable:

MOVE_SOURCE_NOT_AT_EXPECTED_LOCATION — the file is in neither the expected parent nor the destination
MOVE_SOURCE_NOT_FOUND — the file is missing, trashed, or not accessible to this connection
MOVE_UNSUPPORTED — a folder, or a move between different drives
MOVE_DESTINATION_INVALID — the destination is not an accessible folder
MOVE_OUTCOME_UNCONFIRMED — the write was sent to Google Drive but Drive did not answer, so it is unknown whether the file moved. This is an answer you do receive (HTTP 502); it is different from receiving no response or no webhook at all (see below)

Google Drive failures are reported by cause (permissions, quota and rate limits, provider errors); they do not ask for re-authentication unless the token is really rejected.

Unknown outcome, and no automatic retry. A move, or the creation of a destination folder, is never repeated automatically, neither by Bifrost nor by the connector. The outcome can be unknown in two different ways:

You receive MOVE_OUTCOME_UNCONFIRMED. The connector did send the write to Google Drive, but Drive did not answer it. The file may or may not have moved, and a folder may or may not have been created.
You receive no response (a timeout) or, for async, no webhook. You have learned nothing: the request may not have reached Google Drive, the move may be complete, or the result may have been lost on the way.

In both cases check the file before you repeat the request. A repeated request confirms success only when the original file is found in the destination; if the file is still in the expected parent it is moved, otherwise you get MOVE_SOURCE_NOT_AT_EXPECTED_LOCATION.

Async. Accepting an async request is not a completed move. The result is POSTed once to X-Webhook, the same success body or the same error as the sync variant. Bifrost does not retry the webhook and offers no status polling for this operation, so use your own deadline.

POST

google-drive

sync

move-file

Move a file synchronously

curl --request POST \
  --url https://eu.phrase.com/connectors/google-drive/v1/sync/move-file \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "connectorUuid": "4282fec0-d2e9-4266-8733-3e634feb7b59",
  "configuration": {},
  "source": {
    "pathType": "FILE",
    "fileId": "1A2b3C4d5E6f7G8h9I0jK",
    "name": "report.pdf",
    "drive": {
      "driveType": "MY_DRIVE"
    },
    "parentChain": [
      {
        "id": "root",
        "name": "My Drive"
      },
      {
        "id": "0B7_inbox",
        "name": "inbox"
      }
    ]
  },
  "destination": {
    "pathType": "FOLDER",
    "name": "processed",
    "drive": {
      "driveType": "MY_DRIVE"
    },
    "parentChain": [
      {
        "id": "root",
        "name": "My Drive"
      },
      {
        "id": "0B7_inbox",
        "name": "inbox"
      }
    ]
  }
}
'

import requests

url = "https://eu.phrase.com/connectors/google-drive/v1/sync/move-file"

payload = {
    "connectorUuid": "4282fec0-d2e9-4266-8733-3e634feb7b59",
    "configuration": {},
    "source": {
        "pathType": "FILE",
        "fileId": "1A2b3C4d5E6f7G8h9I0jK",
        "name": "report.pdf",
        "drive": { "driveType": "MY_DRIVE" },
        "parentChain": [
            {
                "id": "root",
                "name": "My Drive"
            },
            {
                "id": "0B7_inbox",
                "name": "inbox"
            }
        ]
    },
    "destination": {
        "pathType": "FOLDER",
        "name": "processed",
        "drive": { "driveType": "MY_DRIVE" },
        "parentChain": [
            {
                "id": "root",
                "name": "My Drive"
            },
            {
                "id": "0B7_inbox",
                "name": "inbox"
            }
        ]
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    connectorUuid: '4282fec0-d2e9-4266-8733-3e634feb7b59',
    configuration: {},
    source: {
      pathType: 'FILE',
      fileId: '1A2b3C4d5E6f7G8h9I0jK',
      name: 'report.pdf',
      drive: {driveType: 'MY_DRIVE'},
      parentChain: [{id: 'root', name: 'My Drive'}, {id: '0B7_inbox', name: 'inbox'}]
    },
    destination: {
      pathType: 'FOLDER',
      name: 'processed',
      drive: {driveType: 'MY_DRIVE'},
      parentChain: [{id: 'root', name: 'My Drive'}, {id: '0B7_inbox', name: 'inbox'}]
    }
  })
};

fetch('https://eu.phrase.com/connectors/google-drive/v1/sync/move-file', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://eu.phrase.com/connectors/google-drive/v1/sync/move-file",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'connectorUuid' => '4282fec0-d2e9-4266-8733-3e634feb7b59',
    'configuration' => [
        
    ],
    'source' => [
        'pathType' => 'FILE',
        'fileId' => '1A2b3C4d5E6f7G8h9I0jK',
        'name' => 'report.pdf',
        'drive' => [
                'driveType' => 'MY_DRIVE'
        ],
        'parentChain' => [
                [
                                'id' => 'root',
                                'name' => 'My Drive'
                ],
                [
                                'id' => '0B7_inbox',
                                'name' => 'inbox'
                ]
        ]
    ],
    'destination' => [
        'pathType' => 'FOLDER',
        'name' => 'processed',
        'drive' => [
                'driveType' => 'MY_DRIVE'
        ],
        'parentChain' => [
                [
                                'id' => 'root',
                                'name' => 'My Drive'
                ],
                [
                                'id' => '0B7_inbox',
                                'name' => 'inbox'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://eu.phrase.com/connectors/google-drive/v1/sync/move-file"

	payload := strings.NewReader("{\n  \"connectorUuid\": \"4282fec0-d2e9-4266-8733-3e634feb7b59\",\n  \"configuration\": {},\n  \"source\": {\n    \"pathType\": \"FILE\",\n    \"fileId\": \"1A2b3C4d5E6f7G8h9I0jK\",\n    \"name\": \"report.pdf\",\n    \"drive\": {\n      \"driveType\": \"MY_DRIVE\"\n    },\n    \"parentChain\": [\n      {\n        \"id\": \"root\",\n        \"name\": \"My Drive\"\n      },\n      {\n        \"id\": \"0B7_inbox\",\n        \"name\": \"inbox\"\n      }\n    ]\n  },\n  \"destination\": {\n    \"pathType\": \"FOLDER\",\n    \"name\": \"processed\",\n    \"drive\": {\n      \"driveType\": \"MY_DRIVE\"\n    },\n    \"parentChain\": [\n      {\n        \"id\": \"root\",\n        \"name\": \"My Drive\"\n      },\n      {\n        \"id\": \"0B7_inbox\",\n        \"name\": \"inbox\"\n      }\n    ]\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://eu.phrase.com/connectors/google-drive/v1/sync/move-file")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"connectorUuid\": \"4282fec0-d2e9-4266-8733-3e634feb7b59\",\n  \"configuration\": {},\n  \"source\": {\n    \"pathType\": \"FILE\",\n    \"fileId\": \"1A2b3C4d5E6f7G8h9I0jK\",\n    \"name\": \"report.pdf\",\n    \"drive\": {\n      \"driveType\": \"MY_DRIVE\"\n    },\n    \"parentChain\": [\n      {\n        \"id\": \"root\",\n        \"name\": \"My Drive\"\n      },\n      {\n        \"id\": \"0B7_inbox\",\n        \"name\": \"inbox\"\n      }\n    ]\n  },\n  \"destination\": {\n    \"pathType\": \"FOLDER\",\n    \"name\": \"processed\",\n    \"drive\": {\n      \"driveType\": \"MY_DRIVE\"\n    },\n    \"parentChain\": [\n      {\n        \"id\": \"root\",\n        \"name\": \"My Drive\"\n      },\n      {\n        \"id\": \"0B7_inbox\",\n        \"name\": \"inbox\"\n      }\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://eu.phrase.com/connectors/google-drive/v1/sync/move-file")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"connectorUuid\": \"4282fec0-d2e9-4266-8733-3e634feb7b59\",\n  \"configuration\": {},\n  \"source\": {\n    \"pathType\": \"FILE\",\n    \"fileId\": \"1A2b3C4d5E6f7G8h9I0jK\",\n    \"name\": \"report.pdf\",\n    \"drive\": {\n      \"driveType\": \"MY_DRIVE\"\n    },\n    \"parentChain\": [\n      {\n        \"id\": \"root\",\n        \"name\": \"My Drive\"\n      },\n      {\n        \"id\": \"0B7_inbox\",\n        \"name\": \"inbox\"\n      }\n    ]\n  },\n  \"destination\": {\n    \"pathType\": \"FOLDER\",\n    \"name\": \"processed\",\n    \"drive\": {\n      \"driveType\": \"MY_DRIVE\"\n    },\n    \"parentChain\": [\n      {\n        \"id\": \"root\",\n        \"name\": \"My Drive\"\n      },\n      {\n        \"id\": \"0B7_inbox\",\n        \"name\": \"inbox\"\n      }\n    ]\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "pathType": "FILE",
  "fileId": "1A2b3C4d5E6f7G8h9I0jK",
  "name": "report.pdf",
  "drive": {
    "driveType": "MY_DRIVE"
  },
  "parentChain": [
    {
      "id": "root",
      "name": "My Drive"
    },
    {
      "id": "0B7_inbox",
      "name": "inbox"
    },
    {
      "id": "0B7_processed",
      "name": "processed"
    }
  ]
}

""

Authorizations

Authorization

string

header

required

IDM-issued JWT. Obtain via the IDM authentication flow and pass as: Bearer

Headers

X-ActionId

string

default:""

A logging ID of the request. It is propagated through Phrase systems, making it easier to connect logs from various services. If no ActionId is sent with a request, one will be generated by Bifrost and returned with the response.

Body

application/json

Request payload for moving one Google Drive file to another folder.

A move is a strict relocation: the same file (same fileId, same name) ends up in the destination folder. It is never replaced by a copy, and no other file is overwritten, replaced or deleted. A file with the same name already in the destination does not block the move. Authentication is provided via connectorUuid.

connectorUuid

string

default:""

required

UUID of a configured connector that holds stored Google Drive credentials.

Example:

"b9c06f76-4a44-4d2e-8a26-3d1e4b47e123"

source

object

required

The file to move, together with where you expect it to be.

fileId is required. The last element of parentChain must be the file's direct parent, with an id, exactly as returned by list-files (a file directly in My Drive has the parent { "id": "root", "name": "My Drive" }). An empty parentChain means the drive root. name is informational: the file keeps its name.

The move happens only if the file is in that expected parent. If it is already in the destination folder, the request succeeds without a change. Otherwise the request is rejected with MOVE_SOURCE_NOT_AT_EXPECTED_LOCATION.

Show child attributes

destination

object

required

The folder to move the file into.

With folderId, that folder is used directly. It must be an accessible folder.
Without folderId, name is required. parentChain and name are resolved like the target of upload-raw-file: parents with an id are used directly, named parents are looked up by name, and a missing named folder is created (only when the file is actually going to be moved). When several folders have the same name, the oldest one (by creation time, then by id) is used.

The destination must be in the same drive as the file: My Drive, or the same shared drive. A destination in another drive is rejected with MOVE_UNSUPPORTED.

Show child attributes

configuration

any

default:""

Connector configuration for this request. Currently unused, but reserved for future configuration flags.

Example:

{}

{key}

any

Response

Successful operation. If X-ResponseType is set to 'ID' or no value is sent in the header, the file is saved and can be retrieved by sending a GET request to this endpoint. If X-ResponseType is set to 'OBJECT', the file is returned as a stream.

Resolved file location inside a specific Google Drive space.

Captures drive scope, the ordered chain of parent folders, and the file identifier. For read-only workflows, fileId and all parent ids should be resolved. For export workflows, fileId may be null when creating a new file.

pathType

enum<string>

default:""

required

Shape discriminator for this path. Must be FILE for this DTO.

Available options:

FILE

Example:

"FILE"

drive

object

required

Drive scope for this path.

MY_DRIVE - the authenticated user's "My Drive"
SHARED_DRIVE - a specific shared drive identified by driveId

Option 1
Option 2

Show child attributes

Example:

{ "driveType": "MY_DRIVE" }

parentChain

object[]

required

Ordered chain of parent folders from the drive root down to the direct parent of the file. The file itself is not included.

For read-only workflows, each parent should have a non-empty id so that the connector can reconstruct the full location without additional discovery.

Show child attributes

fileId

string | null

default:""

Google Drive file identifier, when known.

Required for listing or downloading existing files. May be null when the connector is expected to create a new file in the target folder.

Example:

"1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms"

name

string | null

default:""

Human-readable display name of the file. Optional and not guaranteed to be unique within a folder.

Example:

"welcome-email.docx"

{key}

any

Overview

API Documentation

Move a file synchronously

Authorizations

Headers

Body

Response