Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt

Use this file to discover all available pages before exploring further.

A Segment classifies Accounts by shared characteristics or business rules.

​
Before you start

You need an existing Organization and Ledger. Create Segments when Accounts need a shared classification for reporting, routing, fee rules, or operational controls.

​
Create the Segment

To create a Segment, follow these steps:
1
From the Segments page, click the New Segment button.
2
The New Segment form will open on the right side of the screen.
3
Specify the Segment Name in the Segment Details tab.
4
(Optional) Select the Metadata tab to add any metadata that you want to use.
5
Once the information is filled in, click the Save button.
6
The Segment will appear in the list of available Segments for your Ledger.

​
Field guide

FieldWhat to enterExample
Segment NameRequired name for a group of Accounts with shared characteristics or rules.Retail Customers
Metadata KeyOptional classification or integration field name.region
Metadata ValueValue for the metadata key.BR-SP
The fields in the Metadata tab are open. There are no predefined keys or values. Use consistent key names across your Organization, such as region, businessLine, or channel, so Segments stay useful for filtering and reporting.

​
What to do next

After creating the Segment, link it to Accounts from Adding Segment to Account, or create Accounts that should belong to it in Creating an Account.

API equivalent

Create a Segment endpoint