For: Admins and Managers
Look up the columns each import needs
The required and optional CSV columns for every import type, with the formats each one accepts.
In this article8 sections
This page lists the columns each import type in Integration › Imports reads, and how to write their values.
Every import
- The first row holds the column names, in any order, and each row after it is one record. Save the file as CSV UTF-8, so accented names come through.
- A file holds up to 25,000 rows under the column names. A longer one fails as a whole and imports nothing: split it into files of 25,000 rows or fewer, and import each.
- A blank cell counts as not given: the default applies, and nothing is cleared.
- Leave out columns not listed here. Most are ignored, but in Modify users an unknown column fails the row.
- Write dates year first, such as 2026-03-15, and yes or no as
trueorfalse. - Put a list in one cell, separated by commas, such as
role::staff,role::clients. - Name a case by its Tag IDTag ID A permanent label you give a case, such as rear-end-2026, also shown as Reference ID and used in imports. or by its case ID from the Admin Panel's case list. Name a person by their Reference ID or by their user ID, copied from Edit User. Capitals don't matter.
- Write a role as
role::and its name, such asrole::clients. - An import can't fill in custom fields, and doesn't check the ones marked Required: a case or person it creates has them all empty. Fill them in on the case or the person afterwards.
Add users
| Column | What it does | Required | Default |
|---|---|---|---|
username | Their email address, or their mobile number with its country code, such as +12035556677. Someone already in your hub fails the row. | Yes | — |
given_name | First name | Yes | — |
family_name | Last name | Yes | — |
locale | Language: ar, de, en, es, fr, id, it, ja, pl, pt, ru or zh | No | en |
zoneinfo | Time zone, such as America/New_York | No | US/Eastern |
host_ref_id | Your own ID for them, such as a client number: letters, numbers, dashes and slashes, kept in lower case. No two people can share one. | No | None |
host_default_role | The role picked first when they're added to a case, such as role::clients. It grants nothing. | No | None |
host_staff_designation | Their usual staff designation: primary, attorney, paralegal, case_manager, lead_attorney or lead_paralegal | No | primary |
birthdate | Date of birth | No | None |
gender | Male or Female | No | None |
address1, address2, locality, region, postal_code | Address, second line, city, state and ZIP code | No | None |
country | Two-letter country code, such as US | No | None |
company, title | Company and job title | No | None |
host_create_case | true lets them create cases, like Can create a case on Edit User | No | false |
host_add_case_user | The roles they can add people to a case in, like Can add a case user as | No | None |
host_remove_case_user | true lets them remove people from a case, like Can remove a case user | No | false |
Everyone imported is a User. To give someone the Admin Panel, see Give a team member access to the Admin Panel.
Modify users
| Column | What it does | Required | Default |
|---|---|---|---|
user_id | The person to change. An Admin can't be changed by an import. | Yes | — |
host_user_status | 0 disables them and 1 enables them again. | No | Unchanged |
Any Add users column but username | Replaces that detail | No | Unchanged |
An import can't change anyone's email address, phone number or user type. Language and time zone are the person's own once they're in your hub: changing them here doesn't change what they receive.
Create cases
| Column | What it does | Required | Default |
|---|---|---|---|
ref_id | The case's Tag ID: letters, numbers, dashes and slashes, kept in lower case. A Tag ID another case has fails the row. | Yes | — |
title | The case's title | Yes | — |
case_type | One of your hub's case typesCase type A category for cases, such as general, used to aim automations at the right cases., spelled as under Settings › Fields | No | general |
case_status | 1 for open, 0 for closed | No | 1 |
date_opened | The date the case opened | No | Today |
description | The case's description | No | None |
case_stage | The id of its stageStage A step a case moves through, such as Intake or Demand sent, which the firm names and describes and which shows on the case page., copied from its Stage ID in Settings › Stages | No | No stage |
hidden_modules | Sections to hide on this case, separated by commas, such as invoices,notes: any of case, convos, events, forms, signs, invoices, notes, tasks and team | No | None hidden |
Modify cases
| Column | What it does | Required | Default |
|---|---|---|---|
case_id | The case to change | Yes | — |
title, description, case_status, date_opened | As for Create cases, replacing what the case has | No | Unchanged |
case_type | One of your hub's case types, or the case's own type even if you've since removed it from your settings | No | Unchanged |
case_stage | Moves the case to that stage. An import can't take a case off its stage. | No | Unchanged |
hidden_modules | Replaces the sections hidden on the case. An import can't show them all again. | No | Unchanged |
A case's Tag ID can't be changed.
Assign users to cases
| Column | What it does | Required | Default |
|---|---|---|---|
case_id | The case | Yes | — |
user_id | The person to add | Yes | — |
case_role_id | Their role on the case, such as clients, with or without role:: | Yes | — |
case_notify | true sends them the case invitation | Yes | — |
client_designation | In the clients role: primary or guardian | No | primary |
staff_designation | In the staff role or one of your own roles: primary, attorney, paralegal, case_manager, lead_attorney or lead_paralegal | No | primary |
Fill in the column for the row's role and leave the other empty or primary: guardian in a staff or custom role's row, or a staff designation in a clients row, fails the row at that column. Someone already on the case, a case that already has 20 people, or a closed case fails the row too.
Create case posts
| Column | What it does | Required | Default |
|---|---|---|---|
case_id | The case | Yes | — |
user_id | Who the post is from: someone on the case whose role can add posts, such as staff | Yes | — |
message | The post's text | Yes | — |
permissions | The roles who can see it, such as role::staff | No | Everyone on the case |
Each post notifies people as one added by that person would. A row for a closed case fails.
Remove users assigned to cases
| Column | What it does | Required | Default |
|---|---|---|---|
case_id | The case | Yes | — |
user_id | The person to take off it | Yes | — |
Someone who isn't on the case fails the row.