Client statuses
Client statuses let you manage the statuses your organization can assign to clients — for example Lead, Intake or Active. Each status has a name, a color and a display order, and can be active or inactive. One status can be set as the default for new clients. The screen is intended for the organization administrator who maintains the organization's setup.
Overview
| Route | /organization/client-states (overview), /organization/client-states/:clientStateId (detail) |
| Audience | Organization administrator |
| Required permissions | client_states.read (view); client_states.create, client_states.update and client_states.delete for specific actions |
The overview lists all client statuses in a table with the columns Name (with a color dot), Display order, Active and Default. Click a row to open that status's detail screen, where you can edit or delete it.
Create client status
Click + New status at the top right to add a new client status. A dialog opens where you fill in the details. This action requires the client_states.create permission.
| Field | Required | Description |
|---|---|---|
| Name | Yes | The display name of the status, up to 100 characters (e.g. Lead, Intake, Active). |
| Color | No | The color used to display the status. Defaults to grey (#6B7280). |
| Display order | No | Determines the position in the default sorting. Must be 0 or higher. |
| Active | No | Whether the status is available for clients. Checked by default. |
| Default for new clients | No | Whether new clients automatically receive this status. |
Click Create status to save the status, or Cancel to close the dialog without saving.
Sort
Click a column header (Name, Display order or Active) to sort the table by that field. Click again to toggle between ascending and descending. By default the table is sorted by Display order (ascending).
Edit name
Open a status's detail screen and click Edit. In the Name field, change the display name (up to 100 characters) and save the change via Save. Editing requires the client_states.update permission.
Select color
In the detail screen's edit mode (and in the New status dialog) you use the color picker to choose the color used to display the status in the table and on the client file. The chosen hex code is shown next to the picker. Confirm the change with Save.
Edit display order
The Display order field determines the status's position in the default sorting. In edit mode, enter a number of 0 or higher and save via Save. A lower number appears higher in the list.
Toggle active
Use the Active checkbox to control whether the status is available to assign to clients. Uncheck it to deactivate the status without deleting it, and save via Save. Inactive statuses remain visible in the overview with the Inactive label.
Set default
Use the Default for new clients checkbox to control whether new clients automatically receive this status. Check it and save via Save. The default status is recognizable in the overview by the Default label.
Delete
Open the detail screen and click Delete in the Delete section at the bottom. Confirm the action in the dialog. If the status is still in use by clients, it is deactivated instead of permanently deleted. Deleting requires the client_states.delete permission.
Save
In the detail screen's edit mode, save your changes with the Save button. The button is only enabled when something has actually changed. Click Cancel to leave edit mode without saving. Saving requires the client_states.update permission.