Définitions des objets

Chaque fiche que l'API lit et écrit — ses propriétés, ses énumérations et ses liaisons avec les autres fiches.

4 min de lecture Mise à jour le 10 novembre 2026

Chaque page décrit une fiche telle que l'API la lit et l'écrit : ses propriétés, avec leur type et qui les écrit, les valeurs de ses énumérations, et les fiches auxquelles elle se lie. L'intégralité des routes donne les mêmes faits, route par route.

Obligatoire : la propriété doit être donnée à la création.
Lecture seule : elle ne se modifie pas après la création.
Ignorée à la création : le serveur l'écrit seul ; celle que vous envoyez est ignorée.

Les propriétés communes à toutes les fiches

Ces propriétés, que chaque fiche hérite, ne sont pas répétées sur sa page.

Propriété	Type	Description
`AddToBoxIds`	liste d'identifiants	Identifiants des classeurs à lier à l'entité
`ArchiveRetentionYears`	entier	Durée d'archivage en années
`BoxIds`	liste d'identifiants, lecture seule	Identifiants des classeurs liés à l'entité (lecture seule)
`CreationDate`	date et heure (UTC), lecture seule, ignorée à la création	Date de création
`CreationUser`	`DocageUser`, lecture seule, ignorée à la création	Créateur
`CreationUserId`	identifiant, lecture seule, ignorée à la création	Identifiant du créateur
`CultureInfo`	texte	Culture
`CustomFields`	liste de `Field`	Les champs personnalisés de la fiche : ceux de son organisation et ceux de son modèle.
`CustomFieldsForInstances`	liste de `Field`	Champs personnalisés pour les entités générées par le modèle
`CustomFieldsFromOrganization`	liste de `Field`	Champs personnalisés de l'organisation
`CustomFieldsFromTemplate`	liste de `Field`	Champs personnalisés du modèle
`CustomFieldsUserData`	liste de `FieldUserData`	Valeurs des champs personnalisés
`DeletionDate`	date et heure (UTC), lecture seule, ignorée à la création	Date de suppression
`DeletionUser`	`DocageUser`, lecture seule, ignorée à la création	Auteur de la suppression
`DeletionUserId`	identifiant, lecture seule, ignorée à la création	Identifiant de l'auteur de la suppression
`DynamicInclusion`	`DynamicInclusion`	Si une inclusion dynamique est définie, l'entité sera incluse dans son parent que si la condition est remplie
`EntityState`	`StateLevel`, lecture seule	Etat de l'entité
`ExternalId`	texte, 128 caractères au plus	Identifiant externe
`GeneratedByCampaignId`	identifiant, lecture seule, ignorée à la création	Campagne ayant généré l'entité
`GeneratedByFormId`	identifiant	Identifiant du formulaire ayant généré l'entité
`Id`	identifiant, lecture seule, ignorée à la création	Identifiant
`IsArchived`	oui ou non	Archivé
`IsSystem`	oui ou non, lecture seule, ignorée à la création	Est système
`IsTemplate`	oui ou non, lecture seule	Est un modèle
`Language`	`Language`	Langue
`LastModificationDate`	date et heure (UTC), lecture seule, ignorée à la création	Date de modification
`LastModificationUser`	`DocageUser`, lecture seule, ignorée à la création	Dernier modificateur
`LastModificationUserId`	identifiant, lecture seule, ignorée à la création	Identifiant du dernier modificateur
`MergeEntities`	liste de `MergeEntity`	Objets participant à la fusion
`MergeFields`	liste de `MergeField`	Champs de fusion
`MustBeArchived`	oui ou non	Date de début d'archivage
`Name`	texte, 255 caractères au plus	Nom
`Notes`	texte	Notes
`ParentOrganizationId`	identifiant, lecture seule	Organisation parente
`ParentRightsDTO`	liste de `RightDTO`	Les 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.
`RelationDefinitionsForInstances`	liste de `RelationDefinition`	Les 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.
`RelationDefinitionsFromTemplate`	liste de `RelationDefinition`	Les 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).
`RemoveFromBoxIds`	liste d'identifiants	Identifiants des classeurs à délier de l'entité
`TemplateId`	identifiant	Identifiant de Modèle utilisé

Dans ce chapitre

Absence
Les propriétés d'une fiche « Absence », ses énumérations et ses liaisons avec les autres fiches.
Appel
Les propriétés d'une fiche « Appel », ses énumérations et ses liaisons avec les autres fiches.
Calendrier
Les propriétés d'une fiche « Calendrier », ses énumérations et ses liaisons avec les autres fiches.
Campagne
Les propriétés d'une fiche « Campagne », ses énumérations et ses liaisons avec les autres fiches.
Carte
Les propriétés d'une fiche « Carte », ses énumérations et ses liaisons avec les autres fiches.
Cercle
Les propriétés d'une fiche « Cercle », ses énumérations et ses liaisons avec les autres fiches.
Classeur
Les propriétés d'une fiche « Classeur », ses énumérations et ses liaisons avec les autres fiches.
Commande
Les propriétés d'une fiche « Commande », ses énumérations et ses liaisons avec les autres fiches.
Compte de paiement
Les propriétés d'une fiche « Compte de paiement », ses énumérations et ses liaisons avec les autres fiches.
Compte de téléphonie
Les propriétés d'une fiche « Compte de téléphonie », ses énumérations et ses liaisons avec les autres fiches.
Compte email
Les propriétés d'une fiche « Compte email », ses énumérations et ses liaisons avec les autres fiches.
Compte WhatsApp
Les propriétés d'une fiche « Compte WhatsApp », ses énumérations et ses liaisons avec les autres fiches.
Connexion à un calendrier externe
Les propriétés d'une fiche « Connexion à un calendrier externe », ses énumérations et ses liaisons avec les autres fiches.
Contact
Les propriétés d'une fiche « Contact », ses énumérations et ses liaisons avec les autres fiches.
Conversation
Les propriétés d'une fiche « Conversation », ses énumérations et ses liaisons avec les autres fiches.
Document
Les propriétés d'une fiche « Document », ses énumérations et ses liaisons avec les autres fiches.
Email
Les propriétés d'une fiche « Email », ses énumérations et ses liaisons avec les autres fiches.
Enregistrement personnalisé
Les propriétés d'une fiche « Enregistrement personnalisé », ses énumérations et ses liaisons avec les autres fiches.
Équipe
Les propriétés d'une fiche « Équipe », ses énumérations et ses liaisons avec les autres fiches.
Événement
Les propriétés d'une fiche « Événement », ses énumérations et ses liaisons avec les autres fiches.
File d'attente téléphonique
Les propriétés d'une fiche « File d'attente téléphonique », ses énumérations et ses liaisons avec les autres fiches.
Flux
Les propriétés d'une fiche « Flux », ses énumérations et ses liaisons avec les autres fiches.
Formulaire
Les propriétés d'une fiche « Formulaire », ses énumérations et ses liaisons avec les autres fiches.
Groupe
Les propriétés d'une fiche « Groupe », ses énumérations et ses liaisons avec les autres fiches.
Horodatage
Les propriétés d'une fiche « Horodatage », ses énumérations et ses liaisons avec les autres fiches.
Marque
Les propriétés d'une fiche « Marque », ses énumérations et ses liaisons avec les autres fiches.
Message d'absence
Les propriétés d'une fiche « Message d'absence », ses énumérations et ses liaisons avec les autres fiches.
Message WhatsApp
Les propriétés d'une fiche « Message WhatsApp », ses énumérations et ses liaisons avec les autres fiches.
Modèle de code de sécurité
Les propriétés d'une fiche « Modèle de code de sécurité », ses énumérations et ses liaisons avec les autres fiches.
Numéro de téléphonie
Les propriétés d'une fiche « Numéro de téléphonie », ses énumérations et ses liaisons avec les autres fiches.
Objet personnalisé
Les propriétés d'une fiche « Objet personnalisé », ses énumérations et ses liaisons avec les autres fiches.
Organisation
Les propriétés d'une fiche « Organisation », ses énumérations et ses liaisons avec les autres fiches.
Page web
Les propriétés d'une fiche « Page web », ses énumérations et ses liaisons avec les autres fiches.
Paiement
Les propriétés d'une fiche « Paiement », ses énumérations et ses liaisons avec les autres fiches.
Parcours
Les propriétés d'une fiche « Parcours », ses énumérations et ses liaisons avec les autres fiches.
Pipeline
Les propriétés d'une fiche « Pipeline », ses énumérations et ses liaisons avec les autres fiches.
Politique de marque
Les propriétés d'une fiche « Politique de marque », ses énumérations et ses liaisons avec les autres fiches.
Portail
Les propriétés d'une fiche « Portail », ses énumérations et ses liaisons avec les autres fiches.
Poste téléphonique
Les propriétés d'une fiche « Poste téléphonique », ses énumérations et ses liaisons avec les autres fiches.
Règle de dédoublonnage
Les propriétés d'une fiche « Règle de dédoublonnage », ses énumérations et ses liaisons avec les autres fiches.
Réservabilité
Les propriétés d'une fiche « Réservabilité », ses énumérations et ses liaisons avec les autres fiches.
Réservation
Les propriétés d'une fiche « Réservation », ses énumérations et ses liaisons avec les autres fiches.
Réunion
Les propriétés d'une fiche « Réunion », ses énumérations et ses liaisons avec les autres fiches.
Signature de message
Les propriétés d'une fiche « Signature de message », ses énumérations et ses liaisons avec les autres fiches.
Site web
Les propriétés d'une fiche « Site web », ses énumérations et ses liaisons avec les autres fiches.
SMS
Les propriétés d'une fiche « SMS », ses énumérations et ses liaisons avec les autres fiches.
Société
Les propriétés d'une fiche « Société », ses énumérations et ses liaisons avec les autres fiches.
Transfert
Les propriétés d'une fiche « Transfert », ses énumérations et ses liaisons avec les autres fiches.
Type d'absence
Les propriétés d'une fiche « Type d'absence », ses énumérations et ses liaisons avec les autres fiches.
Utilisateur
Les propriétés d'une fiche « Utilisateur », ses énumérations et ses liaisons avec les autres fiches.
Vérification d'identité
Les propriétés d'une fiche « Vérification d'identité », ses énumérations et ses liaisons avec les autres fiches.
Vérification de personne morale
Les propriétés d'une fiche « Vérification de personne morale », ses énumérations et ses liaisons avec les autres fiches.
Webhook
Les propriétés d'une fiche « Webhook », ses énumérations et ses liaisons avec les autres fiches.