Skip to content

Importing Portal Users

To import portal users, you must provide a CSV file containing the required portal user information.

The available columns for this table are:

ColumnDescription
nameRequired. Between 1 and 40 characters.
emailRequired. Must be a valid email address format.
passwordRequired. Between 6 and 120 characters.
adminOptional. A valid boolean value. Defaults to false.
activeOptional. A valid boolean value. Defaults to true.
customer_idOptional. The database ID (UUID) of an existing customer.
customer_codeOptional. The code of an existing customer. Bridge Column.

Customer

A customer is required for every portal user.

You can specify the customer using either:

  • customer_id
  • customer_code

If both columns are provided, customer_id takes precedence.

The customer_code column acts as a bridge column, allowing you to import data without needing to know the database IDs generated by Quick Docket in advance.

Example CSV

All columns

csv
name,email,password,admin,active,customer_id,customer_code
John Smith,john.smith@example.com,Password123,true,true,550e8400-e29b-41d4-a716-446655440000,CUST001

Required columns with customer_id

csv
name,email,password,customer_id
John Smith,john.smith@example.com,Password123,550e8400-e29b-41d4-a716-446655440000

Required Columns with customer_code

csv
name,email,password,customer_code
John Smith,john.smith@example.com,Password123,CUST001