Docs

copyFile

Copy file

POST/v1/files/{idOrKey}/{destinationKey}

Authorization

AuthorizationBearer
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Header parameters

x-destination-bot-id?string
The bot ID to copy the file to. You must have permission to create files in the destination bot. If the destination bot ID is omitted, the file will be copied to the same bot the source file belongs to.
x-bot-idstring
Bot id
x-integration-id?string
Integration id
x-integration-alias?string
Integration alias
x-integration-name?string
Integration name
x-user-id?string
User Id
x-user-role?string
User Role

Path parameters

idOrKeystring
File ID or Key
destinationKeystring
The new key of the file. The file key must not be in use already in the destination bot.

Request body

Additional options for file copying.

overwrite?boolean
Set to `true` to overwrite the file if it already exists, otherwise an error will be returned. When this endpoint is called using bot authentication, the existing file must have been originally created by the same bot making the file copy request in order to overwrite it.

Response

An object containing the file metadata and URL

fileobject