Segments
Agencies can use segments to organize, group, and brand agency Members and Risk Profiles into regions, divisions, departments, or branches, or business units.
The Segment object
A segment object contains the following properties:
Global Properties
These properties are available for all risk profile types.- Name
name- Type
- string
- Description
The name of the segment (e.g. Division, Branch, Department, Group, or Business Unit). If integrating with an AMS, we don't recommend changing the segment name, as this could impact integration functionality.
- Name
display_name- Type
- nullable string
- Description
What displays as the segment name in the app UI and email notifications. The display name can be changed at any time.
- Name
is_default- Type
- bool
- Description
By default, Wunderite creates a Default Segment that all agents and Risk Profiles belong to. The Default Segment can be renamed as necessary. If a Segment with existing data is deleted from Wunderite, then all Risk Profiles are migrated to the Default Segment. Only one segment can be the default. In most cases, this property should be set to
false.
- Name
image- Type
- nullable string
- Description
The URL of the segment's logo uploaded through the Wunderite UI. i.e. this can't be an external URL.