Download Public Import File

Prev Next
Post
/api/v1/downloadPublicImportFile

Download the public import file. Permission required: run-import

Version Description
3.0.0 Added
Header parameters
X-User-Id
stringRequired

The user ID.

ExampleCkCPNctrgCDfmWLqC
X-Auth-Token
stringRequired

The authentication token.

Example1Dd4iN_ClKn5jl-xPC36snQ4s9Zd5GZnXCQuCNSKcVE
Body parameters
object
fileUrl
string Required

The url of the file. It must start with http or https.

importerKey
string Required

It indicates how Rocket.Chat should handle the uploaded file. The accepted importer keys are:

  • csv
  • hipchatenterprise
  • pending-avatars
  • pending-files
  • slack
  • slack-users
Responses
200
400
401
403

OK

object
success
boolean