Définition de l'objet
Politique de marque
BrandPolicy
Les propriétés d'une fiche « Politique de marque », ses énumérations et ses liaisons avec les autres fiches.
Une fiche « Politique de marque », telle que l'API la lit et l'écrit (BrandPolicy dans la référence). Sa liste et sa création : https://staging-api.docage.com/BrandPolicies ; une fiche : https://staging-api.docage.com/BrandPolicies/{id}. Les propriétés communes à toutes les fiches sont sur la page des définitions des objets.
Ses propriétés
ClosedAssistantProvidersliste deAssistantProviderKindFournisseurs d'IA fermés
ClosedModulesliste deProductModuleModules fermés
ConsumeIntegratorCreditsoui ou nonConsommer les crédits de l'intégrateur
DefaultCreditsAlertLimitentierSeuil d'alerte des crédits par défaut
DefaultCreditsAutoOrderLimitentierSeuil de commande automatique par défaut
DefaultCreditsAutoOrderQuantityentierQuantité de crédits d'une commande automatique par défaut
Descriptiontexte, 1000 caractères au plusDescription
Nametexte, 255 caractères au plusObligatoireNom
OrderAutoDebitIntegratoroui ou nonDébit automatique des commandes sur l'intégrateur
PriceForAdditionalSessionHournombrePrix pour une heure de connexion simultanée
PriceForAdditionalTransactionFilenombrePrix pour un fichier supplémentaire de parcours
PriceForAssistantMillionTokensnombrePrix pour un million de jetons de l'assistant IA
PriceForFaceMatchnombrePrix pour une comparaison faciale
PriceForIdentityDocumentChecknombrePrix pour un contrôle de pièce d'identité
PriceForIdentityReusenombrePrix pour une réutilisation d'identité
PriceForIdentityVerificationnombrePrix pour une vérification d'identité complète
PriceForLegalIdentityChecknombrePrix pour une vérification de personne morale
PriceForLegalIdentityRechecknombrePrix pour une relecture du statut légal
PriceForLivenessChecknombrePrix pour une détection du vivant
PriceForMeetingAudioRecordingHournombrePrix pour une heure d'enregistrement audio
PriceForMeetingVideoRecordingHournombrePrix pour une heure d'enregistrement vidéo
PriceForPaymentnombrePrix pour un paiement
PriceForSmsnombrePrix pour un SMS
PriceForStoragenombrePrix pour le stockage
PriceForTimestampnombrePrix pour un horodatage
PriceForTransactionnombrePrix pour un parcours
PriceForTransactionSignatorynombrePrix pour un signataire de parcours
PriceForUsernombrePrix pour un utilisateur
PriceForWhatsAppnombrePrix pour un message WhatsApp
PriceForWhatsAppPlatformFeenombreFrais de plateforme pour un message WhatsApp
Le rôle système (« Tarif public », « Prix de revient ») : posé par le serveur, le code retrouve ces deux politiques par lui.
SubscriptionTransactionTemplateIdidentifiantIdentifiant du modèle de parcours d'abonnement
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
AssistantProviderKind
- 0Mistral
- 1Scaleway
- 2Anthropic
- 3OpenAI
- 4Google
- 5Compatible OpenAI
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
BrandPolicyRole
- 0Aucun
- 1Tarif public
- 2Prix de revient
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).