Import group members from CSV

Two-phase CSV import of members.

Dry run (default): send the CSV as a multipart file or as a csv string. Returns the changes that would be applied, bucketed into new / existing / members / missing. Nothing is written.

Apply: send { "apply": true, "mode": "add" | "replace", ... } with the buckets from the dry run to commit. add only adds; replace also removes current members not in the import.

CSV columns: email (required), first_name, last_name, role.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

Identifier

Body Params
string

Raw CSV text (alternative to a multipart file).

boolean

Set true to commit the import. Omit or false for a dry run.

string
enum

add only adds members; replace also removes current members not in the import.

Allowed:
new_users
array of objects

Users to create and invite (from the dry-run new bucket).

new_users
existing_user_ids
array of integers

Existing account users to attach (from the dry-run existing bucket).

existing_user_ids
remove_user_ids
array of integers

Members to remove (used with replace mode).

remove_user_ids
Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json