Upload Import File

This endpoint takes in the binary content of the imported file, along with additional information about its content, and stores it in a buffer.

Headers

Payload

Example payload

{
    "binaryContent":"/testfile.csv",
    "importerKey":"csv",
    "fileName":"Testfile",
    "contentType":"text/csv"
}

Example Call

curl --location 'http://localhost:3000/api/v1/uploadImportFile' \
--header 'x-auth-token: DTRPbgzQ0EDlTE3sdd3Nt7WfaWZE-lG1ayi9Pfa28Fm' \
--header 'x-user-id: GonjPyg3gB3Z9ur9s' \
--header 'Content-Type: application/json' \
--data '{
    "binaryContent":"/fole/hola",
    "importerKey":"csv",
    "fileName":"Tryout.csv",
    "contentType":"text/csv"
}'

Example Result

Success

{
  "success": true
}

Error

  • Invalid Importer Key: This happens when the importer key does not match any of the accepted options.

{
    "success": false,
    "error": "The importer (png) has no import class defined. [error-importer-not-defined]",
    "errorType": "error-importer-not-defined",
    "details": "uploadImportFile"
}

Change Log

Last updated

Rocket.Chat versions receive support for six months after release.