System label
Reference information about the system label entity
Select environment:
Help
This dropdown lets you select which Dialogporten environment the content of this page should be based on. If unsure, use the default "Staging (TT02)", as this is the environment you would normally test against when integrating Dialogporten.
For bleeding edge, select "Dev", as this contains the most recent unreleased changes to the Dialogporten API. Select "Local dev" if you want to test changes to Dialogporten itself running locally.
For bleeding edge, select "Dev", as this contains the most recent unreleased changes to the Dialogporten API. Select "Local dev" if you want to test changes to Dialogporten itself running locally.
System labels are predefined end-user context labels used by frontends to organize dialogs into folders or sorting categories (e.g., Sent, Bin, Archive).
| SystemLabel | Description |
|---|---|
| Default | Mutually exclusive with Bin/Archive |
| Bin | Mutually exclusive with Default/Archive |
| Archive | Mutually exclusive with Default/Bin |
| Sent | Automatically added by Dialogporten when a transmission of typeSubmission or Correction is added to the dialog.Cannot be added or removed by service owners or end users |
| MarkedAsUnopened | Marks a dialog as unopened/unread. Can be set and removed by service owners and end users |
Default/Bin/Archive are required system labels. They are mutually exclusive, meaning that a dialog can only have one of these labels at a time. If you are bulk changing system labels, use “Add”.
Note: The systemLabels property on the below entities are deprecated. Use the addLabels and removeLabels properties instead.