Définition de l'objet
Marque
Brand
Les propriétés d'une fiche « Marque », ses énumérations et ses liaisons avec les autres fiches.
Une fiche « Marque », telle que l'API la lit et l'écrit (Brand dans la référence). Sa liste et sa création : https://staging-api.docage.com/Brands ; une fiche : https://staging-api.docage.com/Brands/{id}. Les propriétés communes à toutes les fiches sont sur la page des définitions des objets.
Ses propriétés
AccentColortexte, 9 caractères au plusCouleur d'accent
Address1texte, 255 caractères au plusAdresse 1
Address2texte, 255 caractères au plusAdresse 2
BrandPolicyIdidentifiantIdentifiant de la politique de marque
Citytexte, 255 caractères au plusVille
ClosedModulesliste deProductModuleModules non exposés
Countrytexte, 2 caractères au plusPays
FontFamilytexte, 100 caractères au plusPolice
IcontexteIcône
IsActiveoui ou nonActive
IsSystemoui ou nonÉcrite par le serveurMarque système
Keytexte, 40 caractères au plusÉcrite par le serveurClé
LegalNametexte, 255 caractères au plusRaison sociale
LegalNoticeUrltexte, 500 caractères au plusURL des mentions légales
LogotexteLogo
LogoOnDarktexteLogo sur fond sombre
MailBrandMailSettingsÉcrite par le serveurRéglages email
MailFootertextePied de page des emails
MenuMenuSettingsLe menu principal PAR DÉFAUT des organisations servies sous la marque, composé dans sa fiche : suivi par toute organisation qui n'a pas de modèle à elle, puis par tout utilisateur qui n'a rien rangé. Colonne à part du modèle de préférences (Settings), qui se RECOPIE dans les organisations : ce menu-ci se lit à la volée. Sans raccourci (
MenuLayoutHelper.NormalizeShared).Nametexte, 255 caractères au plusObligatoireNom
PaletteColorPaletteLes six rôles de couleur des formulaires et des emails, dérivés des deux couleurs et modifiables un à un.
PrimaryColortexte, 9 caractères au plusCouleur principale
PrivacyUrltexte, 500 caractères au plusURL de la politique de confidentialité
SettingsSettingsLe modèle de préférences utilisateurs de la marque (même classe que celui d'une organisation) : recopié dans le modèle d'une organisation créée sous la marque, et dans celui de chaque organisation servie par
POST Brands/ApplySettingsToAllUsers/{id}, comme « Appliquer à tous les utilisateurs » écrase celui des utilisateurs. Jamais nul : une marque qui n'a rien réglé porte les préférences d'usine.ShortNametexte, 20 caractères au plusNom court
ShowPoweredByoui ou nonAfficher « Propulsé par » la plateforme
SignatureUsagesliste deSignatureUsageUsages de la signature
SmsBrandSmsSettingsÉcrite par le serveurRéglages SMS
SupportEmailtexte, 255 caractères au plusEmail d'assistance
SupportPhonetexte, 50 caractères au plusTéléphone d'assistance
TermsUrltexte, 500 caractères au plusURL des conditions d'utilisation
WebsiteUrltexte, 500 caractères au plusSite web
ZipCodetexte, 20 caractères au plusCode postal
AddToBoxIdsliste d'identifiantsIdentifiants des classeurs à lier à l'entité
ArchiveRetentionYearsentierDurée d'archivage en années
BoxIdsliste d'identifiantsLecture seuleIdentifiants des classeurs liés à l'entité (lecture seule)
CreationDatedate et heure (UTC)Écrite par le serveurDate de création
Créateur
CreationUserIdidentifiantÉcrite par le serveurIdentifiant du créateur
CultureInfotexteCulture
CustomFieldsliste deFieldLes champs personnalisés de la fiche : ceux de son organisation et ceux de son modèle.
CustomFieldsForInstancesliste deFieldChamps personnalisés pour les entités générées par le modèle
CustomFieldsFromOrganizationliste deFieldChamps personnalisés de l'organisation
CustomFieldsFromTemplateliste deFieldChamps personnalisés du modèle
CustomFieldsUserDataliste deFieldUserDataValeurs des champs personnalisés
DeletionDatedate et heure (UTC)Écrite par le serveurDate de suppression
Auteur de la suppression
DeletionUserIdidentifiantÉcrite par le serveurIdentifiant de l'auteur de la suppression
DynamicInclusionDynamicInclusionSi une inclusion dynamique est définie, l'entité sera incluse dans son parent que si la condition est remplie
EntityStateStateLevelLecture seuleEtat de l'entité
ExternalIdtexte, 128 caractères au plusIdentifiant externe
GeneratedByCampaignIdidentifiantÉcrite par le serveurCampagne ayant généré l'entité
GeneratedByFormIdidentifiantIdentifiant du formulaire ayant généré l'entité
IdidentifiantÉcrite par le serveurIdentifiant
IsArchivedoui ou nonArchivé
IsSystemoui ou nonÉcrite par le serveurEst système
IsTemplateoui ou nonLecture seuleEst un modèle
LanguageLanguageLangue
LastModificationDatedate et heure (UTC)Écrite par le serveurDate de modification
Dernier modificateur
LastModificationUserIdidentifiantÉcrite par le serveurIdentifiant du dernier modificateur
MergeEntitiesliste deMergeEntityObjets participant à la fusion
MergeFieldsliste deMergeFieldChamps de fusion
MustBeArchivedoui ou nonDate de début d'archivage
Nametexte, 255 caractères au plusNom
NotestexteNotes
ParentOrganizationIdidentifiantLecture seuleOrganisation parente
ParentRightsDTOliste deRightDTOLes nouveaux droits de la fiche, à sa création ou à sa mise à jour : la liste REMPLACE ses droits, elle doit donc contenir tous les nouveaux droits. Réservé à qui administre la fiche : pouvoir la modifier ne suffit pas.
RelationDefinitionsForInstancesliste deRelationDefinitionLes relations déclarées sur ce modèle : une extrémité est imposée (le modèle lui-même), et la relation ne vaut que pour ses instances — en plus de celles déclarées au niveau de l'organisation dont une extrémité est du même type. Elles se propagent comme CustomFieldsForInstances : une instance les lit dans RelationDefinitionsFromTemplate.
RelationDefinitionsFromTemplateliste deRelationDefinitionLes relations qu'une instance tient de son modèle. Elles ne sont pas recopiées : elles se relisent sur le modèle à chaque lecture. Ajouter une relation sur un modèle la fait donc apparaître sur toutes ses instances existantes, y compris celles créées avant, comme un champ personnalisé (CustomFieldsFromTemplate).
RemoveFromBoxIdsliste d'identifiantsIdentifiants des classeurs à délier de l'entité
TemplateIdidentifiantIdentifiant de Modèle utilisé
Aucune propriété ne correspond.
Ses énumérations
ProductModule
- 10Parcours
- 11Vérification d'identité
- 12Emails
- 13SMS
- 14Horodatage
- 15WhatsApp
- 16Formulaire
- 17Contacts
- 18Classeurs
- 19Sites et pages web
- 20Paiement
- 21Articles
- 22Deals
- 23Devis
- 24Tâches
- 25Tickets
- 26Portails
- 27Calendrier
- 28Documents
- 29Calcul
- 30Chat
- 31Campagnes
- 32Téléphonie
- 33Visio
- 34Réservations
- 35Absences
- 36Automatisation
- 37Pipeline
- 38Objet personnalisé
- 39Webhooks
- 40Assistant IA
- 41Authentification unique
Ses liaisons
Les fiches auxquelles elle se lie, et le rôle de chacune : ce que LinkedToTypeName et LinkedToId retrouvent dans
une liste (voir Lire des listes).