Label Object

Properties
namespacestringRead-onlyminLength 1maxLength 25

Label namespace.

Labels created by site contributors or 3rd-party apps are automatically assigned to the custom namespace.

namespaceDisplayNamestringRead-onlyminLength 1maxLength 180

Display name for the namespace, used to organize the list of labels in the site Dashboard.

keystringRead-onlyminLength 1maxLength 80

Label key.

key is generated when the label is created and cannot be modified, even if displayName changes.

displayNamestringminLength 1maxLength 180

Label display name shown in the Dashboard.

labelTypestringRead-only
4 enum supported values:
UNKNOWNSYSTEMUSER_DEFINEDWIX_APP_DEFINED

Label type.

  • SYSTEM: The label is a default system label for the Contact List.
  • USER_DEFINED: The label was created by a site contributor or 3rd-party app.
  • WIX_APP_DEFINED: The label was created by a Wix app.
createdDatestringRead-onlyformat date-time

Date and time the label was created.

updatedDatestringRead-onlyformat date-time

Date and time the label was last updated.

Was this helpful?
Yes
No