Docage API V2 (beta)
  1. Schemas
Docage API V2 (beta)
  • Avant de commencer
  • Requêtes communes
    • Créer un objet
      • Créer un objet
    • Modifier un objet
      • Modifier un objet
    • Supprimer des objets
      • Supprimer un objet
      • Supprimer plusieurs objets
    • Obtenir des objets
      • Obtenir un objet
        • Récupérer un objet par son Id
        • Récupérer un contact par son email
        • Récupérer un utilisateur par son email
      • Obtenir plusieurs objets
        • Récupérer tous les objets
        • Requêter certaines propriétés uniquement
      • Filtrer les objets
        • Filtrer les transactions supérieure à une date
        • Filtrer les transactions signées ET dont le nom contient "Facture"
        • Filtrer les contacts en fonction des champs personnalisés
        • Filtrer les modèles
        • Filtrer les objets créés à partir d'un modèle
      • Filtrer les objets par classeur
        • Obtenir les objets d'un classeur
      • Trier les objets
        • Trier les contacts par leur prénom
        • Trier les contacts par leur prénom en ordre décroissant
        • Trier les contacts par leur prénom, puis par leur nom en ordre décroissant
      • Paginer les objets
        • Trier les contacts par leur prénom (21 à 30)
        • Trier les contacts par leur prénom en ordre décroissant
        • Trier les contacts par leur prénom, puis par leur nom en ordre décroissant
  • Docage
    • Classeurs
      • Requêtes spécifiques aux classeurs
        • Ajouter des entités à un classeur
        • Supprimer des entités d'un classeur
      • Créer un classeur
      • Créer un classeur à partir d'un modèle
      • Dupliquer des classeurs
      • Modifier un classeur
      • Supprimer un classeur
      • Supprimer des classeurs
      • Obtenir un classeur par son identifiant
      • Obtenir un classeur par son nom
      • Obtenir tous les classeurs accessibles par l'utilisateur
      • Obtenir les entrées de lot de parcours associées au classeur.
      • Obtenir une liste simplifiée des modèles de classeurs accessibles par l'utilisateur
      • Obtenir une liste simplifiée des classeurs accessibles par l'utilisateur
      • Obtenir tous les classeurs accessibles par un cercle
      • Obtenir le nom d'un classeur par son Id
      • Ajouter des objets à un classeur
      • Supprimer des objets à un classeur
    • Cercles
      • Créer un cercle
      • Créer un cercle à partir d'un modèle
      • Dupliquer des cercles
      • Modifier un cercle
      • Supprimer des cercles
      • Supprimer un cercle
      • Obtenir un cercle par son identifiant
      • Obtenir le nom d'un cercle par son Id
      • Obtenir un cercle par son nom
      • Obtenir la liste des membres d'un cercle
      • Obtenir tous les cercles accessibles par l'utilisateur
      • Obtenir une liste simplifiée des modèles de cercles accessibles par l'utilisateur
      • Obtenir une liste simplifiée des cercles accessibles par l'utilisateur
      • Obtenir tous les cercles liés à un classeur
      • Obtenir tous les cercles accessibles par un cercle
      • Appliquer les paramètres utilisateurs à tous les utilisateurs du cercle
      • Appliquer uniquement les paramètres utilisateurs modifiés à tous les utilisateurs du cercle
      • Ajouter des utilisateurs à un cercle
      • Supprimer des utilisateurs à un cercle
      • Ajouter des organisations à un cercle
      • Supprimer des organisations à un cercle
      • Ajouter un cercle dans plusieurs classeurs
      • Supprimer un cercle de plusieurs classeurs
    • Utilisateurs
      • Créer un utilisateur
      • Supprimer des utilisateurs
      • Obtenir un utilisateur par son identifiant
      • Obtenir un utilisateur par son email
      • Obtenir le nom d'un utilisateur par son Id
      • Générer une nouvelle clé API pour un utilisateur
      • Supprime la clé API d'un utilisateur
      • Obtenir tous les utilisateurs accessibles par l'utilisateur
      • Obtenir une liste simplifiée des modèles d'utilisateurs accessibles par l'utilisateur
      • Obtenir une liste simplifiée des utilisateurs accessibles par l'utilisateur
      • Obtenir tous les utilisateurs liés à un classeur
      • Obtenir tous les utilisateurs accessibles par un cercle
      • Envoie un email avec un lien de réinitialisation de mot de passe à un utilisateur
      • Modifier un utilisateur
      • Ajout d'un utilsateur à un ou plusieurs classeurs
      • Supprimer un utilsateur d'un ou plusieurs classeurs
      • Ajoute un utilisateur au cercle des administrateurs de son organisation
      • Supprimer un utilisateur du cercle des administrateurs de son organisation
      • Ajoute un utilisateur au cercle des gestionnaires de crédits de son organisation
      • Supprimer un utilisateur du cercle des gestionnaires de crédits de son organisation
    • Links
      • /Links/{id}
      • /Links
      • /Links
      • /Links/{id}/{password}
    • Orders
      • /Orders/{id}
      • /Orders/{id}
      • Definitively delete orders if they are not processed, paid or invoiced
      • Obtenir une facture
      • Obtenir tous les commandes accessibles par l'utilisateur
      • /Orders
      • Obtenir une liste simplifiée des modèles de commandes accessibles par l'utilisateur
      • Obtenir une liste simplifiée des commandes accessibles par l'utilisateur
      • Obtenir tous les commandes liés à un classeur
      • Obtenir tous les commandes accessibles par un cercle
      • Obtenir un commande par son identifiant
      • Obtenir le nom d'un commande par son Id
      • /Orders/ProcessOrder/{id}
      • /Orders/RejectOrder/{id}
      • /Orders/MarkOrderAsPaid/{id}
      • /Orders/MarkOrderAsInvoiced/{id}
    • Organizations
      • /Organizations
      • Supprimer des organisation
      • Obtenir toutes les organisations accessibles par l'utilisateur
      • Obtenir une liste simplifiée des modèles d'organisations accessibles par l'utilisateur
      • Obtenir une liste simplifiée des organisations accessibles par l'utilisateur
      • Obtenir toutes les organisations liées à un classeur
      • Obtenir toutes les organisations accessibles par un cercle
      • Obtenir une organisation par son identifiant
      • Obtenir le nom d'une organisation par son Id
      • Appliquer les paramètres utilisateurs à tous les utilisateurs de l'organisation
      • Appliquer uniquement les paramètres utilisateurs modifiés à tous les utilisateurs de l'organisation
      • Modifier une organisation
      • /Organizations/BlockOrganization/{id}/{numberOfDays}
    • Rights
      • /Rights/ById/{id}
      • Retrieves all the rights linked to an entity
      • Get default rights for a new entity depending on organization settings
      • Retrieve all the rights owned by a circle
      • Retrieve all the rights owned by a DocageUser
      • Retrieve all the rights owned by an Organization
      • Add a new right
      • Remove rights
    • Classeurs
      • Récupérer les objets d'un classeur
        • Récupérer les transactions d'un classeur
      • Liaisons lors de la création d'un objet
        • Ajouter un objet à un ou plusieurs classeurs à la création
      • Modification des liaisons lors de la modification d'un objet
        • Ajouter un objet à un ou plusieurs classeurs à la modification
        • Supprimer un objet d'un ou plusieurs classeurs à la modification
      • Modification des liaisons entre un objet et les classeurs
        • Ajouter un objet à un/des classeurs
        • Supprimer un objet d'un ou plusieurs classeurs
    • Champs personnalisés
      • Créer un objet avec ses champs personnalisés
      • Modifier les champs personnalisés d'une entité
      • Créer une transaction en renseignant ses champs personnalisés
    • Webhooks
      • Etre notifié lorsqu'un objet change d'état
        • Etre notifié lorsqu'une Transaction est supprimée
        • Etre notifié lorsqu'un Utilisateur est bloqué
        • Etre notifié lorsqu'un Utilisateur est débloqué
      • Créer un webhook
      • Obtenir les webhooks de l'organisation
      • Etre notifié lorsqu'un objet est modifié
      • Etre notifié lorsqu'une Transaction change de statut
      • Etre notifié lorsque le contenu d'un classeur est modifié
      • Etre notifié lorsqu'un formulaire Web est rempli
      • Supprimer un webhook
      • Supprimer des webhooks par leur Url
    • Etat des services Docage
      • Etre notifié de l'état de Docage
  • Docage Contacts
    • Créer un contact
    • Créer un contact à partir d'un modèle
    • Dupliquer des contacts
    • Modifier un contact
    • Supprimer un contact
    • Supprimer des contacts
    • Obtenir un contact par son identifiant
    • Obtenir un contact par son email
    • Obtenir le nom d'un contact par son Id
    • Obtenir tous les contacts accessibles par l'utilisateur
    • Obtenir une liste simplifiée des modèles de contacts accessibles par l'utilisateur
    • Obtenir une liste simplifiée des contacts accessibles par l'utilisateur
    • Obtenir tous les contacts liés à un classeur
    • Obtenir tous les contacts accessibles par un cercle
    • Ajouter un contact dans plusieurs classeurs
    • Supprimer un contact de plusieurs classeurs
  • Docage Doc
    • Créer un document
    • Créer un document à partir d'un modèle
    • Dupliquer des documents
    • Modifier un document
    • Suppression d'un document
    • Supprime plusieurs documents
    • Obtenir un document par son identifiant
    • Obtenir le nom d'un document par son Id
    • Obtenir tous les documents accessibles par l'utilisateur
    • Obtenir une liste simplifiée des modèles de documents accessibles par l'utilisateur
    • Obtenir une liste simplifiée des documents accessibles par l'utilisateur
    • Obtenir tous les documents liés à un classeur
    • Obtenir tous les documents accessibles par un cercle
    • Ajouter un document dans plusieurs classeurs
    • Supprimer un document de plusieurs classeurs
  • Docage Form
    • Créer un formulaire
    • Créer un formulaire à partir d'un modèle
    • Dupliquer des formulaires
    • Modifier un formulaire
    • Supprimer un formulaire
    • Supprimer des formulaires
    • Supprimer un formulaire de plusieurs classeurs
    • Obtenir tous les formulaires accessibles par l'utilisateur
    • Obtenir une liste simplifiée des modèles de formulaires accessibles par l'utilisateur
    • Obtenir une liste simplifiée des formulaires accessibles par l'utilisateur
    • Obtenir tous les formulaires liés à un classeur
    • Obtenir tous les formulaires accessibles par un cercle
    • Obtenir un formulaire par son identifiant
    • Obtenir le nom d'un formulaire par son Id
    • Soumettre un formulaire
    • Ajouter un formulaire dans plusieurs classeurs
  • Docage Mail
    • Emails
      • Créer un email
      • Créer un email à partir d'un modèle d'email
      • Modifier un email
      • Supprimer des emails
      • Supprimer un email
      • Obtenir une liste simplifiée (ID et nom) des modèles d'emails
      • Obtenir la liste des destinataires d'un email
      • Obtenir tous les emails accessibles par l'utilisateur
      • Obtenir une liste simplifiée des emails accessibles par l'utilisateur
      • Obtenir tous les emails liés à un classeur
      • Obtenir tous les emails accessibles par un cercle
      • Obtenir un email par son identifiant
      • Obtenir le nom d'un email par son Id
      • Crée un nouvel email à partir du FormData et envoie éventuellement le courrier.
      • Remplace les destinataires d'un email par la liste de destinataires spécifiée.
      • Envoie un email
      • Dupliquer des emails
      • Ajouter un email dans plusieurs classeurs
      • Supprimer un email de plusieurs classeurs
    • Expéditeurs
      • Supprimer un expéditeur
      • Modifier un expéditeur
      • Supprimer des expéditeurs
      • Get Mailbox of a DocageUser or an Organization
      • /Mailboxes/ByUserId/{id}
      • Créer un expéditeur à partir d'un modèle
      • Obtenir tous les expéditeurs accessibles par l'utilisateur
      • Créer un expéditeur
      • Obtenir une liste simplifiée des modèles d'expéditeurs accessibles par l'utilisateur
      • Obtenir une liste simplifiée des expéditeurs accessibles par l'utilisateur
      • Obtenir tous les expéditeurs liés à un classeur
      • Obtenir tous les expéditeurs accessibles par un cercle
      • Obtenir un expéditeur par son identifiant
      • Obtenir le nom d'un expéditeur par son Id
      • Dupliquer des expéditeurs
      • Tester la connexion SMTP d'un expéditeur
      • Ajouter un expéditeur dans plusieurs classeurs
      • Supprimer un expéditeur de plusieurs classeurs
    • Pièces jointes
      • Suppression de plusieurs pièces jointes
      • Obtenir le contenu du EmailFile encodé en base 64. Le contenu est téléchargé en l'état, par exemple si la email est signée partiellement le contenu du fichier sera téléchargé avec les signatures des membres ayant déjà signé
      • Télécharger une pièce jointe
      • Télécharger un aperçu au format PDF d'une pièce jointe
      • Obtenir le contenu du EmailFile encodé en base 64. Le contenu est téléchargé en l'état, par exemple si la email est signée partiellement le contenu du fichier sera téléchargé avec les signatures des membres ayant déjà signé
    • Destinataires
      • Suppression
      • Obtenir tous les destinataire d'emails accessibles par l'utilisateur
      • NOTE: Le FriendlyName des observateurs de la email ne doivent pas contenir d'espace. Tous les espaces seront supprimés le cas échéant.
      • Obtenir une liste simplifiée des modèles de destinataire d'emails accessibles par l'utilisateur
      • Obtenir une liste simplifiée des destinataire d'emails accessibles par l'utilisateur
      • Obtenir tous les destinataire d'emails liés à un classeur
      • Obtenir tous les destinataire d'emails accessibles par un cercle
      • Obtenir un destinataire d'email par son identifiant
      • Obtenir le nom d'un destinataire d'email par son Id
      • NOTE: Le FriendlyName des membres de la email ne doivent pas contenir d'espace. Tous les espaces seront supprimés le cas échéant.
  • Docage Sign
    • Créer un parcours complet
      • Avec un modèle de parcours
        • Sans modification
          • Sans modification
        • Remplacer un membre
          • Par un contact existant
          • Par un nouveau contact
        • Remplacer un document
          • Avec un nouveau fichier
          • Avec un modèle de document Docage
        • Ajout d'un membre (à venir)
          • Avec un nouveau contact (à venir)
          • Avec un contact existant (à venir)
        • Ajout d'un document (à venir)
          • Avec un nouveau fichier (à venir)
        • Autres exemples
          • Créer un brouillon (sans lancement)
          • Modifier des propriétés héritées du modèle
          • Modifier le mode de signature d'un membre
      • Sans modèle de parcours
        • Ajouter un membre
          • Créer un parcours complet en une seule requête
          • Ajouter un contact existant
        • Insérer plusieurs emplacements de signature pour un membre
        • Créer un brouillon (sans lancement)
        • Utiliser vos propres identifiants dans la requête
    • Créer un parcours seul
      • Créer un parcours seul
      • Ajouter un document à la transaction
      • Créer un membre de parcours
      • Lancer une transaction
    • Télécharger des documents
      • Télécharger un document précis d'une transaction
      • Télécharger tous les documents et le fichier de preuve d'une transaction
      • Télécharger une archive ZIP contenant tous les fichiers d'un parcours (Bytes Array)
      • Télécharger le fichier de preuve au format PDF par défaut (Bytes Array)
      • Télécharger une archive ZIP contenant tous les documents et le fichier de preuve d'un parcours (Bytes Array)
    • Envoyer un rappel
      • Envoyer un rappel à un membre
      • Envoyer un rappel à tous les membres actifs
    • Parcours
      • Modifier un parcours
      • Supprimer un parcours
      • Supprimer des parcours
      • Obtenir les membres d'un parcours
      • Créer un parcours à partir d'un modèle
      • Annuler un parcours
      • Clôturer un parcours
      • Obtenir le statut global de plusieurs parcours
      • Obtenir le statut global de plusieurs parcours
      • Obtenir le statut global de plusieurs parcours
      • Obtenir le statut global de plusieurs parcours
      • Obtenir le statut du parcours au format texte (TransactionGlobalStatus)
      • Obtenir un parcours par son nom
      • Obtenir une liste simplifiée des modèles de parcours accessibles par l'utilisateur
      • Obtenir une liste simplifiée des parcours accessibles par l'utilisateur
      • Obtenir tous les parcours liés à un classeur
      • Obtenir tous les parcours accessibles par un cercle
      • Obtenir un parcours par son identifiant
      • Obtenir le nom d'un parcours par son Id
      • Démarrer un parcours
      • Signer plusieurs parcours avec un code de sécurité.
      • Dupliquer des parcours
      • Ajouter un parcours dans plusieurs classeurs
      • Supprimer un parcours de plusieurs classeurs
      • Obtenir tous les parcours accessibles par l'utilisateur
    • Actions de parcours
      • Créer une action de parcours
      • Supprimer des actions de parcours
      • Obtenir une liste simplifiée des modèles d'actions de parcours accessibles par l'utilisateur
      • Obtenir une liste simplifiée des actions de parcours accessibles par l'utilisateur
      • Obtenir toutes les actions de parcours liées à un classeur
      • Obtenir toutes les actions de parcours accessibles par un cercle
      • Obtenir une action de parcours par son identifiant
      • Obtenir le nom d'une action de parcours par son Id
      • Modifier une action de parcours
    • Membres de parcours
      • Modifier un membre de parcours
      • Supprimer des membres de parcours
      • Obtenir un membre de parcours par son identifiant
      • Obtenir le nom d'un membre de parcours par son Id
      • Obtenir tous les membres de parcours accessibles par l'utilisateur
      • Obtenir une liste simplifiée des modèles d'membres de parcours accessibles par l'utilisateur
      • Obtenir une liste simplifiée des membres de parcours accessibles par l'utilisateur
      • Obtenir tous les membres de parcours liés à un classeur
      • Obtenir tous les membres de parcours accessibles par un cercle
    • Observateurs de parcours
      • Créer un observateur de parcours
      • Modifier un membre de parcours NOTE: Le FriendlyName des membres de parcours ne doivent pas contenir d'espace. Tous les espaces seront supprimés le cas échéant.
      • Supprimer des observateurs de parcours
      • If the transactionId is null : Retrieves all contacts and users the user can view If the transaction is draft : Retrieves all contacts and users the user can view and mark as selected the transaction ones If the transaction is started : Retrieves only t
      • Obtenir un observateur de parcours par son identifiant
      • Obtenir tous les observateurs de parcours accessibles par l'utilisateur
      • Obtenir une liste simplifiée des observateurs de parcours accessibles par l'utilisateur
      • Obtenir une liste simplifiée des modèles d'observateurs de parcours accessibles par l'utilisateur
      • Obtenir tous les observateurs de parcours liés à un classeur
      • Obtenir tous les observateurs de parcours accessibles par un cercle
      • Obtenir le nom d'un observateur de parcours par son Id
      • Obtenir toutes les actions de parcours accessibles par l'utilisateur
    • Fichiers de parcours
      • Télécharger un aperçu fusionné du fichier de parcours au format PDF
      • Supprimer des fichiers de parcours
    • Signatures visuelles
      • Créer un emplacement de signature
      • Créer un emplacement de signature à partir d'un modèle
      • Modifier un emplacement de signature
      • Supprimer des emplacements de signature
      • Supprimer un emplacement de signature
      • Obtenir le nom d'un emplacement de signature par son Id
      • Obtenir tous les emplacements de signature accessibles par l'utilisateur
      • Obtenir une liste simplifiée des modèles d'emplacements de signature accessibles par l'utilisateur
      • Obtenir une liste simplifiée des emplacements de signature accessibles par l'utilisateur
      • Obtenir tous les emplacements de signature liés à un classeur
      • Obtenir tous les emplacements de signature accessibles par un cercle
      • Obtenir un emplacement de signature par son identifiant
      • Dupliquer des emplacements de signature
      • Ajouter un emplacement de signature dans plusieurs classeurs
      • Supprimer un emplacement de signature de plusieurs classeurs
    • Signer plusieurs parcours en une fois
      • Signer plusieurs transactions avec un code unique
      • Obtenir la possibilité pour plusieurs parcours d'être signés par l'utilisateur authentifié
      • Envoyer un code de signature à l'utilisateur authentifié pour signer les parcours.
    • Autres requêtes pour les parcours
      • Docage Sign
        • Lots de parcours
          • Crée un lot de parcours à partir d'un modèle de parcours avec un seul membre dynamique
          • Démarrer des parcours asscoiés aux entrées de lot
          • Remettre en attente des entrées de lot en erreur
      • Récupérer le statut d'une transaction
      • Annuler une transaction
  • Redirections
  • Marque blanche
  • Schemas
    • Schemas
      • ActionSpecificMailSettings
      • ActionStatus
      • ActionSummary
      • BlockingReason
      • Box
      • BoxContact
      • BoxDistributionList
      • BoxDocageUser
      • BoxDocument
      • BoxFile
      • BoxForm
      • BoxMail
      • BoxTransaction
      • ButtonContainerStyle
      • ButtonStyle
      • Circle
      • CircleDocageUser
      • CircleFile
      • CircleOrganization
      • Contact
      • ContactFile
      • ContactsSettings
      • ContainerEmbeddingTextStyle
      • ContainerStyle
      • ContainerWithTextStyle
      • CreditAccount
      • CreditAction
      • CreditReport
      • CreditReportLine
      • CreditType
      • DefaultMailType
      • DistributionList
      • DocageEntity
      • DocageFile
      • DocageUser
      • DocageUserCreationDTO
      • DocageUserFile
      • Document
      • DocumentType
      • DocumentsSettings
      • EncryptionMethod
      • Error
      • ExpressionFilter
      • Field
      • FieldStyle
      • FieldUserData
      • FileSummary
      • Form
      • FormContainerStyle
      • FormFile
      • FormFooterStyle
      • FormObserver
      • FormRenderStyle
      • FormStyle
      • FormStyleType
      • FormsSettings
      • Gender
      • GetContentFrom
      • HeaderStyle
      • HierarchicalEntityDTO
      • HookAction
      • IPersonEntity
      • IdAndName
      • IdAndResult
      • IdAndTransactionGlobalStatus
      • InterfaceSettings
      • Language
      • Link
      • LinkContent
      • LinkFile
      • LinkStyle
      • LinkType
      • ListContainerStyle
      • ListParameter
      • ListRenderStyle
      • ListSettings
      • Log
      • LogAction
      • Mail
      • MailBodyType
      • MailFile
      • MailRecipient
      • MailStatus
      • Mailbox
      • MailsSettings
      • MemberRole
      • MemberStatus
      • MemberSummary
      • MergeEntity
      • MergeField
      • MergeFieldType
      • NavigationBarStyle
      • NotificationBarStyle
      • Order
      • OrderFile
      • Organization
      • OrganizationFile
      • OrganizationStatus
      • OrganizationType
      • PageStyle
      • PersonType
      • PreviewContainerStyle
      • PreviewRenderStyle
      • RatingStyle
      • RecipientSummary
      • RecipientType
      • RedirectionTarget
      • Reminder
      • Right
      • RightDTO
      • RightLevel
      • SecurityCode
      • SecurityCodeStatus
      • SecurityEntity
      • SecurityType
      • Settings
      • SignMode
      • Signability
      • StateLevel
      • TextStyle
      • TitleStyle
      • Transaction
      • TransactionAction
      • TransactionActionType
      • TransactionBatchDTO
      • TransactionBatchEntry
      • TransactionFile
      • TransactionFileType
      • TransactionGlobalStatus
      • TransactionMailSetting
      • TransactionMailSettings
      • TransactionMember
      • TransactionMemberSignatureLocation
      • TransactionObserver
      • TransactionOrderMode
      • TransactionSpecificMailSettings
      • TransactionsSettings
      • Variable
      • Webhook
      • WebhookDTO
  1. Schemas

ActionSpecificMailSettings

{
    "completion": {
        "mailBody": "string",
        "mailId": "631ecf0a-8012-4e45-812e-0d6d19e9dec9",
        "mailSubject": "string"
    },
    "invitation": {
        "mailBody": "string",
        "mailId": "631ecf0a-8012-4e45-812e-0d6d19e9dec9",
        "mailSubject": "string"
    },
    "reminder": {
        "mailBody": "string",
        "mailId": "631ecf0a-8012-4e45-812e-0d6d19e9dec9",
        "mailSubject": "string"
    },
    "start": {
        "mailBody": "string",
        "mailId": "631ecf0a-8012-4e45-812e-0d6d19e9dec9",
        "mailSubject": "string"
    }
}
Built with