v1

latestOpenAPI 3.1.02026-07-24770322.0 KB

Create File

These are 3 API endpoints which create a file object in a File Channel, of type file, folder or link, based on the fileType path parameter that you specify.

post/v1/files/{fileType}

Path parameters

fileTypestring required

The type of file object to be created. This can be 'file', 'folder', or 'link'.

Request body

pathstring required

The full path where the file object will be created. This should include the filename and extension, if relevant

channelIdstring required

The File Channel where the file object will be created.

linkUrlstring

The URL that the link points to (only relevant when fileType = link)

clientPermissions'read_write' | 'read_only'

For folders only, the client permissions on the folder.

Response

200

channelIdstring

createdAtstring

creatorIdstring

downloadUrlstring

idstring

linkUrlstring

namestring

objectstring

pathstring

sizeinteger

statusstring

updatedAtstring

Example response

{
  "channelId": "b1VRvR-zM/c3b39b06-4a7c-4e66-92e3-35201c5f4542",
  "createdAt": "2023-12-01T18:57:50.519785029Z",
  "creatorId": "335775a7-9115-449e-8578-45d798a1c77e",
  "downloadUrl": "https://ridebill-userfiles-mobilehub-310871815.s3-accelerate.amazonaws.com/protected/us-west-2%3A335775a7-9115-449e-8578-45d798a1c77e/files/91c4ed75-c903-4ef2-b9997-a0c0cfc67563/2023-12-01T18%3A57%3A50Z/Lifestyle%20Collection%20Welcome%20Letter%20Template.docx?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAQJQGUNGIYKLIBR77%2F20240312%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20240312T184902Z&X-Amz-Expires=10800&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEEIaCXVzLXdlc3QtMiJIMEYCIQDxD9b4Uno3hkjI83PwDeWN4NkmZ7bzprGSg9u8QOrNJwIhANzy8Y9q0lsd59eAqxIc5SRfvm2pXIzX%2FTpx5UiaOQsQKo0DCEsQBhoMMDIwNDE1MDE1MzEzIgxliEdUd8rIphnvFrUq6gJRaYtNmNC9Ffknv0GpCovpMBQobsubBIRTuc0NafoQkCVpMlIJyFuUUnKNG%2Frv0NJvOPSHVzlIch9PjA3pEqatU79TxuJSyvQ6Iuzw90OLSIemYgGjPYD%2FPvcCx9GowAr6qWH9gmSuFx2nON3JjMWX7d5CBJlJtCbn%2FQHMOczxyYU%2FFuBOUEU7q6yS8ZokB%2FcZT%2Ba%2BhT71Gj%2FtwNZh2WPPMBjM6hMixqdlnP18OvsiKABVsNGvACUb9bHqHkP%2F%2By5XJcxoj%2FrcZbRgNbnowUr0G6t0Obfuma2iTyPgHAkN3WPNfexSLRQm2entcvnXQNJegouW97kivQxnOplI5eYHmn3NKdj9gBdeB2Mde8XhoJnxIiJn%2FjZCpn8ywvn3dANcEqriPzic3ZxmiAyvVpdbvpQRgeFaRyqNutdwWeQPMEj%2FSGh2OZq25mZ20bWo5Kz4JfX60bclzCHseQ5fAoCAy27aLqzDWQcJUzDHocKvBjqcARBj7dApY7uzXTAP%2Bv6E5YRo7dkQGYXnd9bzVhqrGa6pCbYkDjxvQ1yYeSHf5lJawRcA3FE1siv6Qyt7blA%2Bzt%2FrtJewYxhMhYWb9DUpyt0OIBDmlYr6407CQLSQCqL6vU1zPmKtDXLJgHB7xlOsa5jIrBm4zAyDXBHieh%2BT9i%2Fpx25%2FZkoGver5A%2BfamYtw6mBN1ipWsNwNqaHwUQ%3D%3D&X-Amz-SignedHeaders=host&X-Amz-Signature=8c5b7a68842e8962127a57ac6a1616ef6843398cfed7413235dcfc59407200a1",
  "id": "91c4ed75-c903-4ef2-b087-a0c0cfc67563",
  "lastModifiedBy": {
    "id": "9640718b-e291-4c93-8366-989ae26f58c9",
    "object": "internalUser"
  },
  "name": "ExampleFile.docx",
  "object": "file",
  "path": "Welcome Letters/ExampleFile.docx",
  "size": 341141,
  "status": "complete"
}