Définition de l'objet

Campagne

Campaign

Les propriétés d'une fiche « Campagne », ses énumérations et ses liaisons avec les autres fiches.

14 propriétés 2 énumérations 39 liaisons

3 min de lecture Mise à jour le 11 novembre 2026

Une fiche « Campagne », telle que l'API la lit et l'écrit (Campaign dans la référence). Sa liste et sa création : https://staging-api.docage.com/Campaigns ; une fiche : https://staging-api.docage.com/Campaigns/{id}. Les propriétés communes à toutes les fiches sont sur la page des définitions des objets.

38 fiches liées · survolez une fiche pour lire son nom et son rôle

Ses propriétés

ActionCampaignAction
Action
ActionSettingsCampaignActionSettings
Les réglages de l'action hors des médias (le modèle d'un parcours, d'un formulaire…). Colonne JSON.
AudienceCampaignAudienceGroup
La cible : l'arbre de ses sources ; une cible jamais renseignée se lit comme un arbre vide.
CompletedAtUtcdate et heure (UTC)Écrite par le serveur
Terminée le
Descriptiontexte, 1000 caractères au plus
Description
Instancesliste de Campaign
Campagnes tirées de ce modèle
IsMarketingoui ou non
Commerciale
LaunchedAtUtcdate et heure (UTC)Écrite par le serveur
Lancée le
LaunchedByDocageUserIdidentifiantÉcrite par le serveur
Lancée par
MediaCampaignMediaGroup
L'arbre des médias, avec le modèle et le canal de chaque feuille.
Nametexte, 255 caractères au plusObligatoire
Nom
ScheduledAtUtcdate et heure (UTC)Écrite par le serveur
Envoi programmé
StateCampaignStateÉcrite par le serveur
État
TemplateCampaign
Le modèle dont la campagne est tirée — ou, pour un modèle, celui qu'il copie.
AddToBoxIdsliste d'identifiants
Identifiants des classeurs à lier à l'entité
ArchiveRetentionYearsentier
Durée d'archivage en années
BoxIdsliste d'identifiantsLecture seule
Identifiants des classeurs liés à l'entité (lecture seule)
CreationDatedate et heure (UTC)Écrite par le serveur
Date de création
CreationUserDocageUserÉcrite par le serveur
Créateur
CreationUserIdidentifiantÉcrite par le serveur
Identifiant du créateur
CultureInfotexte
Culture
CustomFieldsliste de Field
Les champs personnalisés de la fiche : ceux de son organisation et ceux de son modèle.
CustomFieldsForInstancesliste de Field
Champs personnalisés pour les entités générées par le modèle
CustomFieldsFromOrganizationliste de Field
Champs personnalisés de l'organisation
CustomFieldsFromTemplateliste de Field
Champs personnalisés du modèle
CustomFieldsUserDataliste de FieldUserData
Valeurs des champs personnalisés
DeletionDatedate et heure (UTC)Écrite par le serveur
Date de suppression
DeletionUserDocageUserÉcrite par le serveur
Auteur de la suppression
DeletionUserIdidentifiantÉcrite par le serveur
Identifiant de l'auteur de la suppression
DynamicInclusionDynamicInclusion
Si une inclusion dynamique est définie, l'entité sera incluse dans son parent que si la condition est remplie
EntityStateStateLevelLecture seule
Etat de l'entité
ExternalIdtexte, 128 caractères au plus
Identifiant externe
GeneratedByCampaignIdidentifiantÉcrite par le serveur
Campagne ayant généré l'entité
GeneratedByFormIdidentifiant
Identifiant du formulaire ayant généré l'entité
IdidentifiantÉcrite par le serveur
Identifiant
IsArchivedoui ou non
Archivé
IsSystemoui ou nonÉcrite par le serveur
Est système
IsTemplateoui ou nonLecture seule
Est un modèle
LanguageLanguage
Langue
LastModificationDatedate et heure (UTC)Écrite par le serveur
Date de modification
LastModificationUserDocageUserÉcrite par le serveur
Dernier modificateur
LastModificationUserIdidentifiantÉcrite par le serveur
Identifiant du dernier modificateur
MergeEntitiesliste de MergeEntity
Objets participant à la fusion
MergeFieldsliste de MergeField
Champs de fusion
MustBeArchivedoui ou non
Date de début d'archivage
Nametexte, 255 caractères au plus
Nom
Notestexte
Notes
ParentOrganizationIdidentifiantLecture seule
Organisation parente
ParentRightsDTOliste 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.
RelationDefinitionsForInstancesliste 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.
RelationDefinitionsFromTemplateliste 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).
RemoveFromBoxIdsliste d'identifiants
Identifiants des classeurs à délier de l'entité
TemplateIdidentifiant
Identifiant de Modèle utilisé

Ses énumérations

`CampaignAction`

1Envoyer un message
2Générer des parcours
3Inviter à remplir un formulaire
4Inviter à payer
5Inviter à réserver
6Exécuter un flux

`CampaignState`

0Brouillon
1Programmée
2En cours
3Terminée
4Arrêtée

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).