Start Import

Prev Next
Post
/api/v1/startImport

Triggers the process of importing users, rooms and messages to the workspace. Permission required: run-import

Changelog

Version Description
7.0.0 Remove required extra data from users and channels parameters. Use only record ID of the users or channels.
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
Example
{
  "input": {
    "users": {
      "all": true,
      "list": [
        "testbh"
      ]
    },
    "channels": {
      "all": false,
      "list": [
        "WDuJLFkjwk6L7LdFC"
      ]
    }
  }
}
Expand All
object
input
object Required

The input object contains two arrays: users and channels.

users
object Required

An object of the users to be imported. If all is true, list is ignored.

all
boolean

Set to true to import all users.

list
Array of string

When all is false, list the record IDs of users to be imported.

string
channels
object Required

An object of the channels to import. If all is true, list is ignored.

all
boolean

Set to true to import all channels.

list
Array of string

When all is false, list the record IDs of channels to be imported.

string
Responses
200

OK

Success
{
  "success": true
}
object
success
boolean
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string
403

Forbidden

Permission Error
{
  "success": false,
  "error": "User does not have the permissions required for this action [error-unauthorized]"
}
object
success
boolean
error
string