Docusign
Docusign permet aux organisations de créer, de valider et de gérer leurs contrats dans l’ensemble du cycle de vie de l’accord. Les clients peuvent accélérer les revenus, réduire les risques et libérer de la valeur des contrats qui exécutent leur entreprise.
Ce connecteur est disponible dans les produits et régions suivants :
| Service | classe | Régions |
|---|---|---|
| Copilot Studio | Norme | Toutes les régions Power Automate , à l’exception des éléments suivants : - China Cloud géré par 21Vianet |
| Applications logiques | Norme | Toutes les régions Logic Apps , à l’exception des suivantes : - Régions Azure Chine - Us Department of Defense (DoD) |
| Power Apps | Norme | Toutes les régions Power Apps , à l’exception des suivantes : - China Cloud géré par 21Vianet |
| Power Automate | Norme | Toutes les régions Power Automate , à l’exception des éléments suivants : - China Cloud géré par 21Vianet |
| Contact | |
|---|---|
| Nom | docusign |
| URL | https://support.docusign.com |
| Métadonnées du connecteur | |
|---|---|
| Éditeur | DocuSign, Inc. |
| Site internet | https://www.docusign.com |
| Politique de confidentialité | https://www.docusign.com/company/privacy-policy |
| Catégories | Contenu et fichiers ; Productivité |
Titre
DocuSign aide les organisations à se connecter et à automatiser la façon dont elles préparent, signent, agissent et gèrent des contrats. Le connecteur De démonstration DocuSign se connecte uniquement aux environnements de démonstration DocuSign, mais offre les mêmes fonctionnalités que le connecteur DocuSign standard.
Prerequisites
Pour utiliser le déclencheur Connect dans cette intégration, DocuSign Connect doit être activé dans votre compte DocuSign. Elle n’est pas activée par défaut. Une fois activé, la page Paramètres de connexion est accessible à partir de l’application web DocuSign Admin. L’utilisation du déclencheur Connect dans cette intégration inscrit automatiquement le webhook pour vous.
Documentation du connecteur
Pour obtenir une documentation détaillée sur le connecteur, reportez-vous à https://support.docusign.com/en/guides/DocuSign-eSignature-for-Microsoft-Power-Automate
Problèmes connus et limitations
Pour les problèmes liés à DocuSign, essayez d’abord ce lien : https://support.docusign.com/en/articles/How-Do-I-Open-a-Case-in-the-DocuSign-Support-Center.
Instructions de déploiement
Utilisez ces instructions pour déployer ce connecteur en tant que connecteur personnalisé dans Microsoft Power Automate et Power Apps.
Limitations
| Nom | Appels | Période de renouvellement |
|---|---|---|
| Appels d’API par connexion | 250 | 60 secondes |
Actions
| Afficher le numéro de build (pour référence uniquement. N’incluez pas dans un flux pour l’exécution) |
Identificateur de la build actuellement déployée. |
| Ajouter des documents à une enveloppe |
Ajoutez des documents à une enveloppe. |
| Ajouter des onglets pour un destinataire dans une enveloppe |
Ajouter des onglets pour un destinataire dans une enveloppe |
| Ajouter des rappels pour une enveloppe |
Ajouter des rappels pour une enveloppe |
| Ajouter un destinataire à une enveloppe (V2) |
Ajoutez le destinataire à une enveloppe. |
| Ajouter un type de vérification à un destinataire |
Ajoutez un type de vérification à un destinataire. |
| Appliquer un modèle à des documents |
Appliquer un modèle à des documents |
| Connectez-vous |
Connectez-vous |
| Créer une enveloppe (V2) |
Créez une enveloppe vide. |
| Créer une enveloppe à l’aide de modèles composites |
Créer une enveloppe à l’aide de modèles composites |
| Créer une enveloppe à l’aide d’un modèle |
Créez une enveloppe à l’aide d’un modèle spécifié. |
| Créer une enveloppe à l’aide d’un modèle avec des destinataires |
Créez une enveloppe à l’aide d’un modèle spécifié et spécifiez les destinataires. |
| Créer une enveloppe à l’aide d’un modèle avec des destinataires et des onglets |
Créer une enveloppe à l’aide d’un modèle avec des destinataires et des onglets |
| Créer une liste d’envoi en bloc |
Créer une liste d’envoi en bloc |
| Démarrer le flux de travail Docusign |
Démarrer le flux de travail Docusign |
| DÉPRÉCIÉ : Ajouter un destinataire à une enveloppe (déconseillée) [DÉPRÉCIÉE] |
Ajouter un destinataire à une enveloppe (déconseillée). |
| DÉPRÉCIÉ : Créer une enveloppe à l’aide d’un modèle (déconseillé) [DÉPRÉCIÉ] |
Créez une enveloppe à l’aide d’un modèle spécifié (déconseillé). |
| DÉPRÉCIÉ : Obtenir des documents à partir d’une enveloppe (déconseillée) [DÉCONSEILLÉE] |
Obtenir des documents à partir de l’enveloppe (déconseillé) |
| Enveloppe d’envoi en bloc à l’aide d’un modèle |
Enveloppe d’envoi en bloc à l’aide d’un modèle |
| Envoyer une enveloppe |
Envoyez une enveloppe existante. |
| Générer l’URL de l’expéditeur incorporé |
Générer l’URL de l’expéditeur incorporé |
| Générer l’URL de signature incorporée (V2) |
Générer l’URL de signature incorporée (V2) |
| Générer l’URL de signature incorporée [DÉCONSEILLÉE] |
Générer une URL de signature incorporée |
| Mettre à jour le champ personnalisé de l’enveloppe |
Mettre à jour la valeur du champ personnalisé d’enveloppe spécifié |
| Mettre à jour le destinataire sur une enveloppe |
Mettre à jour le destinataire sur une enveloppe |
| Mettre à jour les champs de formulaire de génération de document à partir de l’enveloppe |
Mettre à jour les champs de formulaire de génération de document à partir de l’enveloppe |
| Mettre à jour les onglets de prérempliage de l’enveloppe |
Mettre à jour les valeurs d’une liste d’onglets de préremplis |
| Mettre à jour les valeurs de l’onglet destinataire sur une enveloppe |
Mettre à jour les valeurs de l’onglet destinataire sur une enveloppe |
| Modèles de liste |
Répertorier les modèles d’un compte spécifique. |
| Obtenir des champs de formulaire de génération de document à partir de l’enveloppe |
Obtenir des champs de formulaire de génération de document à partir de l’enveloppe |
| Obtenir des champs de formulaire de génération de document à partir du modèle (modèles d’envoi en bloc uniquement) |
Obtenir des champs de formulaire de génération de document à partir du modèle (modèles d’envoi en bloc uniquement) |
| Obtenir des champs personnalisés de document à partir de l’enveloppe |
Obtenir des champs personnalisés de document à partir de l’enveloppe |
| Obtenir des documents à partir d’une enveloppe |
Obtenir des documents à partir d’une enveloppe |
| Obtenir des informations pour l’onglet destinataire |
Retourne la valeur de l’onglet pour le destinataire donné |
| Obtenir des informations sur le document à partir de l’enveloppe |
Obtenir des informations sur le document à partir de l’enveloppe |
| Obtenir des informations sur les destinataires à partir de l’enveloppe |
Obtenir des informations sur les destinataires à partir de l’enveloppe |
| Obtenir des onglets de document à partir de l’enveloppe |
Obtenir des onglets de document à partir de l’enveloppe |
| Obtenir des onglets de document à partir d’un modèle |
Obtenir des onglets de document à partir d’un modèle |
| Obtenir la liste des événements d’audit |
Obtenir la liste des événements d’audit |
| Obtenir les informations sur les champs personnalisés de l’enveloppe |
Obtenir les informations de champ personnalisées de l’enveloppe. |
| Obtenir les onglets des destinataires à partir de l’enveloppe |
Obtenir les onglets des destinataires à partir de l’enveloppe |
| Renvoyer l’enveloppe |
Cette action renvoie une enveloppe Docusign ou envoie un rappel aux destinataires qui doivent signer un contrat Docusign en fonction d’un EnvelopeId fourni. |
| Répertorier les destinataires d’une enveloppe |
Répertorier les destinataires d’une enveloppe |
| Répertorier les documents à partir d’un modèle |
Répertorier les documents à partir d’un modèle |
| Répertorier les documents à partir d’une enveloppe |
Répertorier les documents à partir d’une enveloppe |
| Répertorier les enveloppes |
Cette action renvoie des enveloppes Docusign pertinentes en fonction de l’état de l’enveloppe, de la plage de dates, du nom du destinataire, de l’adresse e-mail du destinataire, du titre de l’enveloppe, du nom du document ou de la valeur de champ personnalisé de l’enveloppe. La sortie est le titre, la description, l’ID d’enveloppe, les noms de documents, les noms d’expéditeurs, l’état de l’enveloppe, la date d’envoi et une URL de l’enveloppe qui peut être utilisée comme lien pour afficher l’enveloppe dans Docusign. |
| Supprimer le destinataire d’une enveloppe |
Supprimer le destinataire d’une enveloppe |
| Vider l’enveloppe |
Videz l’enveloppe. |
Afficher le numéro de build (pour référence uniquement. N’incluez pas dans un flux pour l’exécution)
Identificateur de la build actuellement déployée.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Numéro de build
|
buildNumber | dynamic |
Retours
- response
- object
Ajouter des documents à une enveloppe
Ajoutez des documents à une enveloppe.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de compte
|
accountId | True | string |
Entrez ou sélectionnez un ID de compte. |
|
ID d’enveloppe
|
envelopeId | True | string |
Entrez un ID d’enveloppe. |
|
Document Base64 *
|
documentBase64 | True | string |
Base64 du contenu du document |
|
Type de document *
|
fileExtension | True | string |
pdf, docx, etc. |
|
Nom du document *
|
name | True | string |
nom du document |
|
Transformer des champs Pdf
|
transformPdfFields | string |
Faux |
|
|
Affecter des onglets au destinataire
|
assignTabsToRecipientId | string |
ID du destinataire |
Retours
- Corps
- AddDocumentsResponse
Ajouter des onglets pour un destinataire dans une enveloppe
Ajouter des onglets pour un destinataire dans une enveloppe
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de compte
|
accountId | True | string |
Entrez ou sélectionnez un ID de compte. |
|
ID d’enveloppe
|
envelopeId | True | string |
Entrez un ID d’enveloppe. |
|
ID du destinataire
|
recipientId | True | string |
Entrez un ID de destinataire. |
|
Type d’onglet
|
tabType | True | string |
Type d’onglet |
|
Détails de l’onglet
|
tabDetails | True | dynamic |
Détails de l’onglet ancre sélectionné. |
Retours
- Corps
- AddRecipientTabsResponse
Ajouter des rappels pour une enveloppe
Ajouter des rappels pour une enveloppe
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de compte
|
accountId | True | string |
Entrez ou sélectionnez un ID de compte. |
|
ID d’enveloppe
|
envelopeId | True | string |
Entrez un ID d’enveloppe. |
|
Rappel activé
|
reminderEnabled | True | boolean |
Lorsque la valeur est false, les rappels sont désactivés. La valeur par défaut est false |
|
Délai de rappel
|
reminderDelay | True | string |
Ajoutez le nombre de jours après lesquels le destinataire reçoit un e-mail de rappel. |
|
Fréquence de rappel
|
reminderFrequency | True | string |
Ajoutez le nombre de jours entre les e-mails de rappel. |
|
Expirer après
|
expireAfter | string |
Ajoutez le nombre de jours avant l’expiration. |
Retours
- Corps
- AddRemindersResponse
Ajouter un destinataire à une enveloppe (V2)
Ajoutez le destinataire à une enveloppe.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de compte
|
accountId | True | string |
Entrez ou sélectionnez un ID de compte. |
|
ID d’enveloppe
|
envelopeId | True | string |
Entrez un ID d’enveloppe. |
|
Type de destinataire
|
recipientType | True | string |
Entrez ou sélectionnez un type de destinataire. |
|
ID d’utilisateur client
|
clientUserId | string |
ID d’utilisateur client pour le signataire incorporé |
|
|
ID du destinataire
|
recipientId | string |
Entrez un ID de destinataire. |
|
|
URL de démarrage du destinataire incorporé
|
embeddedRecipientStartURL | string |
Chaîne d’URL fournie par l’expéditeur pour rediriger un destinataire incorporé. |
|
|
Ordre de signature
|
routingOrder | string |
Ordre de signature du destinataire. |
|
|
Langue de notification par e-mail
|
emailNotificationLanguage | string |
Langue de la notification par e-mail. |
|
|
Objet de notification par e-mail
|
emailNotificationSubject | string |
Objet de la notification par e-mail. |
|
|
Corps de la notification par e-mail
|
emailNotificationBody | string |
Corps de la notification par e-mail. |
|
|
Note
|
note | string |
Note personnalisée pour le destinataire. |
|
|
Nom du rôle
|
roleName | string |
Nom du rôle associé au destinataire. |
|
|
Code du pays SMS
|
countryCode | string |
Pour les notifications SMS, le code du pays, sans signe + de début. |
|
|
Numéro de téléphone SMS
|
phoneNumber | string |
E-mail du signataire ou téléphone SMS requis. Excluez le code de pays pour le numéro de téléphone. |
|
|
Groupe de signature
|
signingGroupId | string |
Groupe de signature |
|
|
Type de signature
|
signatureType | string |
Types de signature basée sur des normes DocuSign (SBS). |
|
|
Flux de travail de vérification
|
workflowId | string |
Les flux de travail IDV avec des types de signature de stylet doivent être sélectionnés ici. |
|
|
détails pour le type de destinataire sélectionné
|
additionalRecipientParams | dynamic |
Détails pour le type de destinataire sélectionné. |
Retours
- Corps
- Signer
Ajouter un type de vérification à un destinataire
Ajoutez un type de vérification à un destinataire.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de compte
|
accountId | True | string |
Entrez ou sélectionnez un ID de compte. |
|
ID d’enveloppe
|
envelopeId | True | string |
Entrez un ID d’enveloppe. |
|
ID du destinataire
|
recipientId | True | string |
Entrez un ID de destinataire. |
|
Type de destinataire
|
recipientType | True | string |
Entrez ou sélectionnez un type de destinataire. |
|
Type de vérification
|
verificationType | True | string |
Type de vérification |
|
Données de destinataire supplémentaires
|
additionalRecipientData | dynamic |
Données de destinataire supplémentaires. |
Appliquer un modèle à des documents
Appliquer un modèle à des documents
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de compte
|
accountId | True | string |
Entrez ou sélectionnez un ID de compte. |
|
ID d’enveloppe
|
envelopeId | True | string |
Entrez un ID d’enveloppe. |
|
ID de modèle
|
templateId | True | string |
Entrez ou sélectionnez un ID de modèle. |
|
Conserver le destinataire du modèle
|
preserve_template_recipient | string |
Faux |
|
|
ID du document
|
documentId | True | string |
ID du document |
|
Page de démarrage du document
|
documentStartPage | True | string |
Page de démarrage du document |
|
Page de fin de document
|
documentEndPage | True | string |
Page de fin de document |
Connectez-vous
Créer une enveloppe (V2)
Créez une enveloppe vide.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de compte
|
accountId | True | string |
Entrez ou sélectionnez un ID de compte. |
|
Sujet de l’e-mail
|
emailSubject | True | string |
Objet de l’e-mail. |
|
body
|
body | dynamic |
Corps de l’e-mail et champs personnalisés de compte. |
Retours
- Corps
- CreateEnvelopeResponse
Créer une enveloppe à l’aide de modèles composites
Créer une enveloppe à l’aide de modèles composites
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de compte
|
accountId | True | string |
Entrez ou sélectionnez un ID de compte. |
|
Sujet de l’e-mail
|
emailSubject | True | string |
Objet de l’e-mail. |
|
Corps du message électronique
|
emailBody | string |
Corps de l’e-mail. |
|
|
État de l’enveloppe
|
status | True | string |
État de l’enveloppe |
|
Fusionner des rôles et supprimer des destinataires vides
|
merge_roles_on_draft | string |
Fusionner des rôles et supprimer des destinataires vides |
|
|
body
|
body | dynamic |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID d’enveloppe
|
envelopeId | string |
ID de l’enveloppe. |
|
Statut
|
status | string |
État de l’enveloppe. |
|
Heure de la date d’état
|
statusDateTime | string |
Date/heure de la définition de l’état. |
|
URI
|
uri | string |
URI de l’enveloppe dans DocuSign. |
Créer une enveloppe à l’aide d’un modèle
Créez une enveloppe à l’aide d’un modèle spécifié.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de compte
|
accountId | True | string |
Entrez ou sélectionnez un ID de compte. |
|
ID de modèle
|
templateId | True | string |
Entrez ou sélectionnez un ID de modèle. |
|
État de l’enveloppe
|
status | True | string |
État de l’enveloppe |
Retours
- Corps
- CreateEnvelopeResponse
Créer une enveloppe à l’aide d’un modèle avec des destinataires
Créez une enveloppe à l’aide d’un modèle spécifié et spécifiez les destinataires.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de compte
|
accountId | True | string |
Entrez ou sélectionnez un ID de compte. |
|
État de l’enveloppe
|
status | True | string |
État de l’enveloppe |
|
ID de modèle
|
templateId | True | string |
Entrez ou sélectionnez un ID de modèle. |
|
Signataires
|
signers | dynamic |
Signataires du document. |
|
|
Sujet de l’e-mail
|
emailSubject | string |
Sujet de l’e-mail |
|
|
Corps du message électronique
|
emailBody | string |
Corps du message électronique |
Retours
- Corps
- CreateEnvelopeResponse
Créer une enveloppe à l’aide d’un modèle avec des destinataires et des onglets
Créer une enveloppe à l’aide d’un modèle avec des destinataires et des onglets
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de compte
|
accountId | True | string |
Entrez ou sélectionnez un ID de compte. |
|
ID de modèle
|
templateId | True | string |
Entrez ou sélectionnez un ID de modèle. |
|
Destinataires
|
recipients | dynamic |
Signataires du document. |
|
|
Fusionner des rôles et supprimer des destinataires vides
|
merge_roles_on_draft | string |
Fusionner des rôles et supprimer des destinataires vides |
|
|
Sujet de l’e-mail
|
emailSubject | string |
Sujet de l’e-mail |
Retours
- Corps
- CreateEnvelopeResponse
Créer une liste d’envoi en bloc
Créer une liste d’envoi en bloc
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de compte
|
accountId | True | string |
Entrez ou sélectionnez un ID de compte. |
|
Nom de liste d’envoi en bloc
|
name | True | string |
Nom de liste d’envoi en bloc |
|
Fichier CSV
|
csv | string |
Charger un fichier CSV |
|
|
Champs de génération de document
|
rawOutput | object |
Champs de génération de document |
Retours
- Corps
- BulkSendListGuid
Démarrer le flux de travail Docusign
Démarrer le flux de travail Docusign
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de compte
|
accountId | True | string |
Entrez ou sélectionnez un ID de compte. |
|
flux de travail
|
workflowId | True | string |
Entrez l’ID de flux de travail ou sélectionnez le nom du flux de travail dans la liste déroulante. |
|
nom de l’instance
|
instanceName | True | string |
Nom de l’instance de workflow |
|
variable
|
variable | dynamic |
Retours
TriggerMaestroFlowResponse
- response
- object
DÉPRÉCIÉ : Ajouter un destinataire à une enveloppe (déconseillée) [DÉPRÉCIÉE]
Ajouter un destinataire à une enveloppe (déconseillée).
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Compte
|
accountId | True | string |
ID de compte |
|
Enveloppe
|
envelopeId | True | string |
ID d’enveloppe |
|
Nom du signataire
|
AddRecipientToEnvelopeName | True | string |
Nom du destinataire. |
|
E-mail du signataire
|
AddRecipientToEnvelopeEmail | True | string |
E-mail du destinataire. |
|
Ordre de signature
|
routingOrder | string |
Ordre de signature du destinataire dans le document. |
|
|
Role
|
roleName | string |
Rôle du signataire. |
Retours
- Corps
- ListRecipientsResponse
DÉPRÉCIÉ : Créer une enveloppe à l’aide d’un modèle (déconseillé) [DÉPRÉCIÉ]
Créez une enveloppe à l’aide d’un modèle spécifié (déconseillé).
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de compte
|
accountId | True | string |
Entrez ou sélectionnez un ID de compte. |
|
ID de modèle
|
templateId | True | string |
Entrez ou sélectionnez un ID de modèle. |
|
État de l’enveloppe
|
status | True | string |
État de l’enveloppe |
|
Champs personnalisés
|
accountCustomFields | True | dynamic |
Obtenez les champs personnalisés définis au niveau du compte. |
Retours
- Corps
- CreateEnvelopeResponse
DÉPRÉCIÉ : Obtenir des documents à partir d’une enveloppe (déconseillée) [DÉCONSEILLÉE]
Obtenir des documents à partir de l’enveloppe (déconseillé)
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Compte
|
accountId | True | string |
ID de compte |
|
ID d’enveloppe
|
envelopeId | True | string |
Entrez un ID d’enveloppe. |
|
Certificat de saisie semi-automatique
|
certificate | True | boolean |
Lorsque la valeur est false, le certificat de signature d’enveloppe est supprimé du téléchargement. |
Retours
- response
- GetDocumentsResponse
Enveloppe d’envoi en bloc à l’aide d’un modèle
Enveloppe d’envoi en bloc à l’aide d’un modèle
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de compte
|
accountId | True | string |
Entrez ou sélectionnez un ID de compte. |
|
GUID de liste d’envoi en bloc
|
bulkSendListId | True | string |
GUID de liste d’envoi en bloc |
|
ID de modèle
|
envelopeOrTemplateId | True | string |
Entrez l’ID de modèle ou choisissez un modèle dans la liste déroulante |
Retours
- Corps
- BulkSendListGuid
Envoyer une enveloppe
Envoyez une enveloppe existante.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de compte
|
accountId | True | string |
Entrez ou sélectionnez un ID de compte. |
|
ID d’enveloppe
|
envelopeId | True | string |
Entrez un ID d’enveloppe. |
Retours
- response
- object
Générer l’URL de l’expéditeur incorporé
Générer l’URL de l’expéditeur incorporé
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de compte
|
accountId | True | string |
Entrez ou sélectionnez un ID de compte. |
|
ID d’enveloppe
|
envelopeId | True | string |
Entrez un ID d’enveloppe. |
|
Ouvrir dans
|
openIn | True | string |
Ouvrir dans |
|
URL de retour
|
returnUrl | True | string |
URL de retour |
|
URL ajoutée supplémentaire
|
additionalURL | dynamic |
URL ajoutée supplémentaire. |
Retours
- Corps
- EmbeddedSenderResponse
Générer l’URL de signature incorporée (V2)
Générer l’URL de signature incorporée (V2)
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de compte
|
accountId | True | string |
Entrez ou sélectionnez un ID de compte. |
|
ID d’enveloppe
|
envelopeId | True | string |
Entrez un ID d’enveloppe. |
|
Est-ce un signataire en personne ?
|
isInPersonSigner | True | string |
Oui/non |
|
Méthode d’authentification
|
authenticationMethod | True | string |
Méthode d’authentification |
|
URL de retour
|
returnUrl | True | string |
URL de retour |
|
URL ajoutée supplémentaire
|
additionalURL | True | dynamic |
URL ajoutée supplémentaire. |
Retours
- Corps
- EmbeddedSigningResponse
Générer l’URL de signature incorporée [DÉCONSEILLÉE]
Générer une URL de signature incorporée
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de compte
|
accountId | True | string |
Entrez ou sélectionnez un ID de compte. |
|
ID d’enveloppe
|
envelopeId | True | string |
Entrez un ID d’enveloppe. |
|
Nom du signataire
|
signerName | True | string |
Nom du signataire |
|
E-mail du signataire
|
signerEmail | True | string |
E-mail du signataire |
|
ID d’utilisateur client
|
clientUserId | string |
Obligatoire, sauf si le signataire est en personne. Laissez vide pour les signataires en personne |
|
|
Méthode d’authentification
|
authenticationMethod | True | string |
Méthode d’authentification |
|
URL de retour
|
returnUrl | True | string |
URL de retour |
|
URL ajoutée supplémentaire
|
additionalURL | dynamic |
URL ajoutée supplémentaire. |
Retours
- Corps
- EmbeddedSigningResponse
Mettre à jour le champ personnalisé de l’enveloppe
Mettre à jour la valeur du champ personnalisé d’enveloppe spécifié
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de compte
|
accountId | True | string |
Entrez ou sélectionnez un ID de compte. |
|
ID d’enveloppe
|
envelopeId | True | string |
Entrez un ID d’enveloppe. |
|
ID de champ
|
fieldId | True | string |
ID de champ personnalisé |
|
Type de champ
|
fieldType | True | string |
Type de champ personnalisé |
|
Nom
|
name | True | string |
Nom de champ personnalisé |
|
Valeur
|
value | True | string |
Valeur de champ personnalisée |
Retours
Mettre à jour le destinataire sur une enveloppe
Mettre à jour le destinataire sur une enveloppe
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de compte
|
accountId | True | string |
Entrez ou sélectionnez un ID de compte. |
|
ID d’enveloppe
|
envelopeId | True | string |
Entrez un ID d’enveloppe. |
|
ID du destinataire
|
recipientId | True | string |
Entrez un ID de destinataire. |
|
Type de signature
|
signatureType | string |
Types de signature basée sur des normes DocuSign (SBS). |
|
|
Type de destinataire
|
recipientType | True | string |
Type de destinataire |
|
ID d’utilisateur client
|
clientUserId | string |
ID d’utilisateur client pour le signataire incorporé |
|
|
URL de démarrage du destinataire incorporé
|
embeddedRecipientStartURL | string |
Chaîne d’URL fournie par l’expéditeur pour rediriger un destinataire incorporé. |
|
|
Ordre de signature
|
routingOrder | string |
Ordre de signature du destinataire. |
|
|
Langue de notification par e-mail
|
emailNotificationLanguage | string |
Langue de la notification par e-mail. |
|
|
Objet de notification par e-mail
|
emailNotificationSubject | string |
Objet de la notification par e-mail. |
|
|
Corps de la notification par e-mail
|
emailNotificationBody | string |
Corps de la notification par e-mail. |
|
|
Note
|
note | string |
Note personnalisée pour le destinataire. |
|
|
Nom du rôle
|
roleName | string |
Nom du rôle associé au destinataire. |
|
|
Code du pays SMS
|
countryCode | string |
Pour les notifications SMS, le code du pays, sans signe + de début. |
|
|
Numéro de téléphone SMS
|
phoneNumber | string |
E-mail du signataire ou téléphone SMS requis. Excluez le code de pays pour le numéro de téléphone. |
|
|
Groupe de signature
|
signingGroupId | string |
Groupe de signature |
|
|
détails pour le type de destinataire sélectionné
|
additionalRecipientParams | dynamic |
Détails pour le type de destinataire sélectionné. |
Retours
- Corps
- Signer
Mettre à jour les champs de formulaire de génération de document à partir de l’enveloppe
Mettre à jour les champs de formulaire de génération de document à partir de l’enveloppe
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de compte
|
accountId | True | string |
Entrez ou sélectionnez un ID de compte. |
|
ID d’enveloppe
|
envelopeId | True | string |
Entrez un ID d’enveloppe. |
|
Document GUID
|
documentGuid | True | string |
Document GUID |
|
Type
|
fieldType | string |
Choisir le type de champ de génération de document à mettre à jour |
|
|
Nom
|
name | string |
Entrez le nom du champ ou le nom de la colonne de table |
|
|
Valeur
|
value | string |
Entrez les données de champ |
|
|
Étiquette
|
label | string |
Obligatoire pour « Ligne de table ». Entrez l’étiquette du champ docgen. |
|
|
: Nom de la table
|
tableName | string |
Obligatoire pour « Ligne de table ». Entrez le nom de la table. |
|
|
: ligne de tableau
|
rowNumber | string |
Obligatoire pour « Ligne de table ». Entrez le numéro de ligne |
Mettre à jour les onglets de prérempliage de l’enveloppe
Mettre à jour les valeurs d’une liste d’onglets de préremplis
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de compte
|
accountId | True | string |
Entrez ou sélectionnez un ID de compte. |
|
ID d’enveloppe
|
envelopeId | True | string |
Entrez un ID d’enveloppe. |
|
ID du document
|
documentId | True | string |
Entrez un ID de document. |
|
Type
|
tabType | string |
Type |
|
|
ID
|
tabId | string |
ID |
|
|
Valeur
|
value | string |
Valeur |
Mettre à jour les valeurs de l’onglet destinataire sur une enveloppe
Mettre à jour les valeurs de l’onglet destinataire sur une enveloppe
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de compte
|
accountId | True | string |
Entrez ou sélectionnez un ID de compte. |
|
ID d’enveloppe
|
envelopeId | True | string |
Entrez un ID d’enveloppe. |
|
ID du destinataire
|
recipientId | True | string |
Entrez un ID de destinataire. |
|
Type
|
tabType | string |
Type d’onglet |
|
|
ID
|
tabId | string |
ID |
|
|
Valeur
|
value | string |
Valeur |
Modèles de liste
Répertorier les modèles d’un compte spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de compte
|
accountId | True | string |
Entrez ou sélectionnez un ID de compte. |
Retours
- Corps
- ListTemplatesResponse
Obtenir des champs de formulaire de génération de document à partir de l’enveloppe
Obtenir des champs de formulaire de génération de document à partir de l’enveloppe
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de compte
|
accountId | True | string |
Entrez ou sélectionnez un ID de compte. |
|
ID d’enveloppe
|
envelopeId | True | string |
Entrez un ID d’enveloppe. |
Retours
- Corps
- DocGenFormFieldsResponse
Obtenir des champs de formulaire de génération de document à partir du modèle (modèles d’envoi en bloc uniquement)
Obtenir des champs de formulaire de génération de document à partir du modèle (modèles d’envoi en bloc uniquement)
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de compte
|
accountId | True | string |
Entrez ou sélectionnez un ID de compte. |
|
ID de modèle
|
templateId | True | string |
Entrez ou sélectionnez un ID de modèle. |
Retours
Champs de formulaire de génération de document à partir du modèle
- Champs de modèle DocGen
- object
Obtenir des champs personnalisés de document à partir de l’enveloppe
Obtenir des champs personnalisés de document à partir de l’enveloppe
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de compte
|
accountId | True | string |
Entrez ou sélectionnez un ID de compte. |
|
ID d’enveloppe
|
envelopeId | True | string |
Entrez un ID d’enveloppe. |
|
ID du document
|
documentId | True | string |
Entrez un ID de document. |
Retours
Obtenir des documents à partir d’une enveloppe
Obtenir des documents à partir d’une enveloppe
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de compte
|
accountId | True | string |
Entrez ou sélectionnez un ID de compte. |
|
ID d’enveloppe
|
envelopeId | True | string |
Entrez un ID d’enveloppe. |
|
Format de sortie
|
documentId | True | string |
Entrez « string(ID de document) » pour obtenir un document unique, ou sélectionnez un format. |
|
Certificat de langue d’achèvement (facultatif)
|
language | string |
Sélectionner une langue |
Retours
- response
- GetDocumentsResponse
Obtenir des informations pour l’onglet destinataire
Retourne la valeur de l’onglet pour le destinataire donné
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de compte
|
accountId | True | string |
Entrez ou sélectionnez un ID de compte. |
|
ID d’enveloppe
|
envelopeId | True | string |
Entrez un ID d’enveloppe. |
|
ID du destinataire
|
recipientId | True | string |
Entrez un ID de destinataire. |
|
Étiquette d’onglet
|
tabLabel | True | string |
Étiquette d’onglet |
Retours
- Corps
- Tab
Obtenir des informations sur le document à partir de l’enveloppe
Obtenir des informations sur le document à partir de l’enveloppe
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de compte
|
accountId | True | string |
Entrez ou sélectionnez un ID de compte. |
|
ID d’enveloppe
|
envelopeId | True | string |
Entrez un ID d’enveloppe. |
|
Nom du document
|
documentName | True | string |
Nom de fichier avec extension |
Retours
- Corps
- EnvelopeDocument
Obtenir des informations sur les destinataires à partir de l’enveloppe
Obtenir des informations sur les destinataires à partir de l’enveloppe
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de compte
|
accountId | True | string |
Entrez ou sélectionnez un ID de compte. |
|
ID d’enveloppe
|
envelopeId | True | string |
Entrez un ID d’enveloppe. |
|
E-mail du destinataire
|
recipientEmail | string |
E-mail du destinataire |
|
|
Indicatif
|
areaCode | string |
Code de zone du destinataire |
|
|
Numéro de téléphone
|
phoneNumber | string |
Numéro de téléphone du destinataire |
|
|
ID du destinataire
|
recipientId | string |
Entrez un ID de destinataire. |
Retours
- Corps
- Signer
Obtenir des onglets de document à partir de l’enveloppe
Obtenir des onglets de document à partir de l’enveloppe
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de compte
|
accountId | True | string |
Entrez ou sélectionnez un ID de compte. |
|
ID d’enveloppe
|
envelopeId | True | string |
Entrez un ID d’enveloppe. |
|
ID du document
|
documentId | True | string |
Entrez un ID de document. |
Retours
- Corps
- ListTabsResponse
Obtenir des onglets de document à partir d’un modèle
Obtenir des onglets de document à partir d’un modèle
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de compte
|
accountId | True | string |
Entrez ou sélectionnez un ID de compte. |
|
ID de modèle
|
templateId | True | string |
Entrez ou sélectionnez un ID de modèle. |
|
ID du document
|
documentId | True | string |
Entrez un ID de document. |
Retours
- Corps
- ListTabsResponse
Obtenir la liste des événements d’audit
Obtenir la liste des événements d’audit
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de compte
|
accountId | True | string |
Entrez ou sélectionnez un ID de compte. |
|
ID d’enveloppe
|
envelopeId | True | string |
Entrez un ID d’enveloppe. |
Retours
- response
- object
Obtenir les informations sur les champs personnalisés de l’enveloppe
Obtenir les informations de champ personnalisées de l’enveloppe.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de compte
|
accountId | True | string |
Entrez ou sélectionnez un ID de compte. |
|
ID d’enveloppe
|
envelopeId | True | string |
Entrez un ID d’enveloppe. |
|
Nom de champ personnalisé
|
fieldName | True | string |
Nom de champ personnalisé |
Retours
Obtenir les onglets des destinataires à partir de l’enveloppe
Obtenir les onglets des destinataires à partir de l’enveloppe
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de compte
|
accountId | True | string |
Entrez ou sélectionnez un ID de compte. |
|
ID d’enveloppe
|
envelopeId | True | string |
Entrez un ID d’enveloppe. |
|
ID du destinataire
|
recipientId | True | string |
Entrez un ID de destinataire. |
Retours
- Corps
- RecipientTabsResponse
Renvoyer l’enveloppe
Cette action renvoie une enveloppe Docusign ou envoie un rappel aux destinataires qui doivent signer un contrat Docusign en fonction d’un EnvelopeId fourni.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’enveloppe
|
envelopeId | True | string |
Entrez un ID d’enveloppe. |
Retours
- response
- object
Répertorier les destinataires d’une enveloppe
Répertorier les destinataires d’une enveloppe
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de compte
|
accountId | True | string |
Entrez ou sélectionnez un ID de compte. |
|
ID d’enveloppe
|
envelopeId | True | string |
Entrez un ID d’enveloppe. |
Retours
- Corps
- ListRecipientsResponse
Répertorier les documents à partir d’un modèle
Répertorier les documents à partir d’un modèle
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de compte
|
accountId | True | string |
Entrez ou sélectionnez un ID de compte. |
|
ID de modèle
|
templateId | True | string |
Entrez ou sélectionnez un ID de modèle. |
Retours
Répertorier les documents à partir d’une enveloppe
Répertorier les documents à partir d’une enveloppe
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de compte
|
accountId | True | string |
Entrez ou sélectionnez un ID de compte. |
|
ID d’enveloppe
|
envelopeId | True | string |
Entrez un ID d’enveloppe. |
Retours
- Corps
- ListDocumentsResponse
Répertorier les enveloppes
Cette action renvoie des enveloppes Docusign pertinentes en fonction de l’état de l’enveloppe, de la plage de dates, du nom du destinataire, de l’adresse e-mail du destinataire, du titre de l’enveloppe, du nom du document ou de la valeur de champ personnalisé de l’enveloppe. La sortie est le titre, la description, l’ID d’enveloppe, les noms de documents, les noms d’expéditeurs, l’état de l’enveloppe, la date d’envoi et une URL de l’enveloppe qui peut être utilisée comme lien pour afficher l’enveloppe dans Docusign.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de compte
|
accountId | True | string |
Entrez ou sélectionnez un ID de compte. |
|
Nom du destinataire
|
recipientName | string |
Cette action répertorie les enveloppes en fonction du nom du destinataire |
|
|
E-mail du destinataire
|
recipientEmailId | string |
Filtre les enveloppes par e-mail du destinataire |
|
|
Objet de l’enveloppe
|
envelopeTitle | string |
Filtre les enveloppes par objet d’enveloppe |
|
|
Nom du champ personnalisé
|
customFieldName | string |
Cette action répertorie les enveloppes en fonction d’un nom de ses champs personnalisés |
|
|
Valeur de champ personnalisée
|
customFieldValue | string |
Filtre par valeur de champ personnalisée |
|
|
Mot de recherche
|
search_text | string |
Entrez un mot clé pour rechercher les correspondances dans les sujets d’enveloppe, les destinataires et les champs personnalisés. |
|
|
État de l’enveloppe
|
envelopeStatus | string |
Cette action répertorie les enveloppes en fonction de l’état de l’enveloppe |
|
|
Dossier
|
folder_ids | string |
Filtre les enveloppes par le dossier sélectionné |
|
|
Commande par
|
order_by | string |
Trie les enveloppes dans l’ordre sélectionné |
|
|
Enveloppes de retour
|
top | integer |
Spécifiez le nombre d’enveloppes à retourner (la valeur par défaut est 10 ; la valeur maximale est de 1 000) |
|
|
Ignorer les enveloppes
|
skip | integer |
Spécifier le nombre d’enveloppes à ignorer à partir du début |
|
|
Date de début
|
from_date | date-time |
Entrez la date de début au format UTC : 2017-05-02T01:44z |
|
|
Date de fin
|
to_date | date-time |
Entrez la date de fin au format UTC : 2017-05-02T01:44z. |
Retours
Supprimer le destinataire d’une enveloppe
Supprimer le destinataire d’une enveloppe
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de compte
|
accountId | True | string |
Entrez ou sélectionnez un ID de compte. |
|
Dossier
|
folderId | True | string |
ID de dossier |
|
ID d’enveloppe
|
envelopeId | True | string |
Entrez un ID d’enveloppe. |
|
ID du destinataire
|
RemoveRecipientFromEnvelopeRecipientId | True | string |
ID du destinataire |
Retours
- Corps
- ListRecipientsResponse
Vider l’enveloppe
Videz l’enveloppe.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de compte
|
accountId | True | string |
Entrez ou sélectionnez un ID de compte. |
|
ID d’enveloppe
|
envelopeId | True | string |
Entrez un ID d’enveloppe. |
|
Motif void
|
voidedReason | True | string |
Raison annulée |
Retours
- response
- object
Déclencheurs
| DÉCONSEILLÉ : Lorsqu’un état de l’enveloppe change (Connect) (V2) (déconseillé) [DÉPRÉCIÉ] |
Déclenche un nouveau flux lorsqu’un état d’enveloppe change (déconseillé). |
| DÉCONSEILLÉ : Lorsqu’un état de l’enveloppe change (Se connecter) (déconseillé) [DÉPRÉCIÉ] |
Déclenche un nouveau flux lorsqu’un état d’enveloppe change (déconseillé). |
| Lorsqu’un état d’enveloppe change (Connect) (V3) |
Déclenche un nouveau flux lorsqu’un état d’enveloppe change. |
| Lorsqu’un événement Docusign Connect se produit (au niveau de l’organisation) |
Déclenche un nouveau flux lorsqu’un état d’enveloppe change. |
| Lorsqu’un événement Docusign Connect se produit (au niveau du compte) |
Déclenche un nouveau flux lorsqu’un état d’enveloppe change. |
DÉCONSEILLÉ : Lorsqu’un état de l’enveloppe change (Connect) (V2) (déconseillé) [DÉPRÉCIÉ]
Déclenche un nouveau flux lorsqu’un état d’enveloppe change (déconseillé).
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Compte
|
accountId | True | string |
ID de compte |
|
Nom de connexion
|
name | True | string | |
|
Événement d’enveloppe
|
envelopeEvents | True | string |
Retours
DÉCONSEILLÉ : Lorsqu’un état de l’enveloppe change (Se connecter) (déconseillé) [DÉPRÉCIÉ]
Déclenche un nouveau flux lorsqu’un état d’enveloppe change (déconseillé).
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Compte
|
accountId | True | string |
ID de compte |
|
Nom de connexion
|
name | True | string | |
|
Événement d’enveloppe
|
envelopeEvents | True | string |
Retours
- Corps
- WebhookEnvelopeResponse
Lorsqu’un état d’enveloppe change (Connect) (V3)
Déclenche un nouveau flux lorsqu’un état d’enveloppe change.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Compte
|
accountId | True | string |
ID de compte |
|
Nom de connexion
|
name | True | string | |
|
Événement d’enveloppe
|
envelopeEvents | True | string |
Retours
Lorsqu’un événement Docusign Connect se produit (au niveau de l’organisation)
Déclenche un nouveau flux lorsqu’un état d’enveloppe change.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’organisation
|
organizationId | True | string |
Entrez ou sélectionnez un ID d’organisation. |
|
Connecter le nom de la configuration
|
name | True | string |
Nommez votre configuration Connect (par exemple, « Événements d’enveloppe »). |
|
Événements déclencheurs
|
events | True | array of string |
Sélectionnez un événement. Pour inclure un autre événement, sélectionnez « Ajouter un nouvel élément ». |
Retours
Lorsqu’un événement Docusign Connect se produit (au niveau du compte)
Déclenche un nouveau flux lorsqu’un état d’enveloppe change.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de compte
|
accountId | True | string |
Entrez un ID de compte ou sélectionnez un compte dans la liste déroulante. |
|
Connecter le nom de la configuration
|
name | True | string |
Nommez votre configuration Connect (par exemple, « Événements d’enveloppe »). |
|
Événements déclencheurs
|
events | True | array of string |
Sélectionnez un événement. Pour inclure un autre événement, sélectionnez « Ajouter un nouvel élément ». |
Retours
Définitions
WebhookEnvelopeResponseV2
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Champs personnalisés
|
data.envelopeSummary.customFields | object |
Paires clé-valeur représentant les champs personnalisés de cette enveloppe (où la clé est le nom du champ et la valeur est la valeur du champ). |
|
Enveloppe créée Date-Time
|
data.envelopeSummary.createdDateTime | date-time |
aaaa-MM-ddTHH :mm :ss.fffZ |
|
ID d’enveloppe
|
data.envelopeSummary.envelopeId | string | |
|
Enveloppe envoyée Date-Time
|
data.envelopeSummary.sentDateTime | date-time |
aaaa-MM-ddTHH :mm :ss.fffZ |
|
État de l’enveloppe
|
data.envelopeSummary.status | string | |
|
Objet de l’e-mail
|
data.envelopeSummary.emailSubject | string | |
|
Nom de l’expéditeur
|
data.envelopeSummary.sender.userName | string | |
|
ID d’utilisateur de l’expéditeur
|
data.envelopeSummary.sender.userId | string | |
|
ID de compte de l’expéditeur
|
data.envelopeSummary.sender.accountId | string | |
|
Adresse e-mail de l’expéditeur
|
data.envelopeSummary.sender.email | string | |
|
Signataires
|
data.envelopeSummary.recipients.signers | array of object | |
|
Tabulations
|
data.envelopeSummary.recipients.signers.tabs | object |
Paires clé-valeur représentant les onglets de ce destinataire (où la clé est le nom du champ et la valeur est la valeur du champ). |
|
E-mail du destinataire
|
data.envelopeSummary.recipients.signers.email | string | |
|
ID du destinataire
|
data.envelopeSummary.recipients.signers.recipientId | string | |
|
Ordre de routage
|
data.envelopeSummary.recipients.signers.routingOrder | string | |
|
Destinataire envoyé Date-Time
|
data.envelopeSummary.recipients.signers.sentDateTime | date-time |
aaaa-MM-ddTHH :mm :ss.fffZ |
|
État du destinataire
|
data.envelopeSummary.recipients.signers.status | string |
État du destinataire. |
|
Type de destinataire
|
data.envelopeSummary.recipients.signers.recipientType | string |
Type de destinataire. |
|
Type de vérification
|
data.envelopeSummary.recipients.signers.verificationType | string |
Type de la vérification. |
|
Nom du destinataire
|
data.envelopeSummary.recipients.signers.name | string |
Nom du destinataire. |
WebhookEnvelopeResponseV3
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Champs personnalisés
|
data.envelopeSummary.customFields | object |
Paires clé-valeur représentant les champs personnalisés de cette enveloppe (où la clé est le nom du champ et la valeur est la valeur du champ). |
|
Enveloppe créée Date-Time
|
data.envelopeSummary.createdDateTime | date-time |
aaaa-MM-ddTHH :mm :ss.fffZ |
|
ID d’enveloppe
|
data.envelopeSummary.envelopeId | string | |
|
Enveloppe envoyée Date-Time
|
data.envelopeSummary.sentDateTime | date-time |
aaaa-MM-ddTHH :mm :ss.fffZ |
|
État de l’enveloppe
|
data.envelopeSummary.status | string | |
|
Objet de l’e-mail
|
data.envelopeSummary.emailSubject | string | |
|
Nom de l’expéditeur
|
data.envelopeSummary.sender.userName | string | |
|
ID d’utilisateur de l’expéditeur
|
data.envelopeSummary.sender.userId | string | |
|
ID de compte de l’expéditeur
|
data.envelopeSummary.sender.accountId | string | |
|
Adresse e-mail de l’expéditeur
|
data.envelopeSummary.sender.email | string | |
|
Signataires
|
data.envelopeSummary.recipients.signers | array of object | |
|
Tabulations
|
data.envelopeSummary.recipients.signers.tabs | object |
Paires clé-valeur représentant les onglets de ce destinataire (où la clé est le nom du champ et la valeur est la valeur du champ). |
|
E-mail du destinataire
|
data.envelopeSummary.recipients.signers.email | string | |
|
ID du destinataire
|
data.envelopeSummary.recipients.signers.recipientId | string | |
|
Ordre de routage
|
data.envelopeSummary.recipients.signers.routingOrder | string | |
|
Destinataire envoyé Date-Time
|
data.envelopeSummary.recipients.signers.sentDateTime | date-time |
aaaa-MM-ddTHH :mm :ss.fffZ |
|
État du destinataire
|
data.envelopeSummary.recipients.signers.status | string |
État du destinataire. |
|
Type de destinataire
|
data.envelopeSummary.recipients.signers.recipientType | string |
Type de destinataire. |
|
Type de vérification
|
data.envelopeSummary.recipients.signers.verificationType | string |
Type de la vérification. |
|
Nom du destinataire
|
data.envelopeSummary.recipients.signers.name | string |
Nom du destinataire. |
WebhookEnvelopeResponseV4
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Champs personnalisés d’enveloppe
|
data.envelopeSummary.customFields | object |
Paires clé-valeur représentant les champs personnalisés de cette enveloppe (où la clé est le nom du champ et la valeur est la valeur du champ). |
|
Enveloppe créée Date-Time
|
data.envelopeSummary.createdDateTime | date-time |
aaaa-MM-ddTHH :mm :ss.fffZ |
|
ID d’enveloppe
|
data.envelopeSummary.envelopeId | string | |
|
Enveloppe envoyée Date-Time
|
data.envelopeSummary.sentDateTime | date-time |
aaaa-MM-ddTHH :mm :ss.fffZ |
|
État de l’enveloppe
|
data.envelopeSummary.status | string | |
|
Objet de l’e-mail
|
data.envelopeSummary.emailSubject | string | |
|
envelopeDocuments
|
data.envelopeSummary.envelopeDocuments | array of object | |
|
ID du document
|
data.envelopeSummary.envelopeDocuments.documentId | string | |
|
Document Guid
|
data.envelopeSummary.envelopeDocuments.documentIdGuid | string | |
|
Nom du document
|
data.envelopeSummary.envelopeDocuments.name | string | |
|
Nom de l’expéditeur
|
data.envelopeSummary.sender.userName | string | |
|
ID d’utilisateur de l’expéditeur
|
data.envelopeSummary.sender.userId | string | |
|
ID de compte de l’expéditeur
|
data.envelopeSummary.sender.accountId | string | |
|
Adresse e-mail de l’expéditeur
|
data.envelopeSummary.sender.email | string | |
|
Signataires
|
data.envelopeSummary.recipients.signers | array of object | |
|
Tabulations
|
data.envelopeSummary.recipients.signers.tabs | object |
Paires clé-valeur représentant les onglets de ce destinataire (où la clé est le nom du champ et la valeur est la valeur du champ). |
|
E-mail du destinataire
|
data.envelopeSummary.recipients.signers.email | string | |
|
ID du destinataire
|
data.envelopeSummary.recipients.signers.recipientId | string | |
|
Ordre de routage
|
data.envelopeSummary.recipients.signers.routingOrder | string | |
|
Destinataire envoyé Date-Time
|
data.envelopeSummary.recipients.signers.sentDateTime | date-time |
aaaa-MM-ddTHH :mm :ss.fffZ |
|
État du destinataire
|
data.envelopeSummary.recipients.signers.status | string |
État du destinataire. |
|
Type de destinataire
|
data.envelopeSummary.recipients.signers.recipientType | string |
Type de destinataire. |
|
Type de vérification
|
data.envelopeSummary.recipients.signers.verificationType | string |
Type de la vérification. |
|
Nom du destinataire
|
data.envelopeSummary.recipients.signers.name | string |
Nom du destinataire. |
WebhookOrganizationResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID d’organisation
|
data.organizationId | string |
ID d’organisation. |
|
Champs personnalisés
|
data.envelopeSummary.customFields | object |
Paires clé-valeur représentant les champs personnalisés de cette enveloppe (où la clé est le nom du champ et la valeur est la valeur du champ). |
|
Enveloppe créée Date-Time
|
data.envelopeSummary.createdDateTime | date-time |
aaaa-MM-ddTHH :mm :ss.fffZ |
|
ID d’enveloppe
|
data.envelopeSummary.envelopeId | string | |
|
Enveloppe envoyée Date-Time
|
data.envelopeSummary.sentDateTime | date-time |
aaaa-MM-ddTHH :mm :ss.fffZ |
|
État de l’enveloppe
|
data.envelopeSummary.status | string | |
|
Objet de l’e-mail
|
data.envelopeSummary.emailSubject | string | |
|
envelopeDocuments
|
data.envelopeSummary.envelopeDocuments | array of object | |
|
ID du document
|
data.envelopeSummary.envelopeDocuments.documentId | string | |
|
Document Guid
|
data.envelopeSummary.envelopeDocuments.documentIdGuid | string | |
|
Nom du document
|
data.envelopeSummary.envelopeDocuments.name | string | |
|
Nom de l’expéditeur
|
data.envelopeSummary.sender.userName | string | |
|
ID d’utilisateur de l’expéditeur
|
data.envelopeSummary.sender.userId | string | |
|
ID de compte de l’expéditeur
|
data.envelopeSummary.sender.accountId | string | |
|
Adresse e-mail de l’expéditeur
|
data.envelopeSummary.sender.email | string | |
|
Signataires
|
data.envelopeSummary.recipients.signers | array of object | |
|
Tabulations
|
data.envelopeSummary.recipients.signers.tabs | object |
Paires clé-valeur représentant les onglets de ce destinataire (où la clé est le nom du champ et la valeur est la valeur du champ). |
|
E-mail du destinataire
|
data.envelopeSummary.recipients.signers.email | string | |
|
ID du destinataire
|
data.envelopeSummary.recipients.signers.recipientId | string | |
|
Ordre de routage
|
data.envelopeSummary.recipients.signers.routingOrder | string | |
|
Destinataire envoyé Date-Time
|
data.envelopeSummary.recipients.signers.sentDateTime | date-time |
aaaa-MM-ddTHH :mm :ss.fffZ |
|
État du destinataire
|
data.envelopeSummary.recipients.signers.status | string |
État du destinataire. |
|
Type de destinataire
|
data.envelopeSummary.recipients.signers.recipientType | string |
Type de destinataire. |
|
Type de vérification
|
data.envelopeSummary.recipients.signers.verificationType | string |
Type de la vérification. |
|
Nom du destinataire
|
data.envelopeSummary.recipients.signers.name | string |
Nom du destinataire. |
WebhookEnvelopeResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Champs personnalisés d’enveloppe
|
customFields | object |
Paires clé-valeur représentant les champs personnalisés de cette enveloppe (où la clé est le nom du champ et la valeur est la valeur du champ). |
|
Enveloppe créée Date-Time
|
DocuSignEnvelopeInformation.EnvelopeStatus.Created | date-time |
aaaa-MM-ddTHH :mm :ss.fffZ |
|
Adresse e-mail de l’expéditeur
|
DocuSignEnvelopeInformation.EnvelopeStatus.Email | string | |
|
ID d’enveloppe
|
DocuSignEnvelopeInformation.EnvelopeStatus.EnvelopeID | string | |
|
Adresse IP de l’expéditeur
|
DocuSignEnvelopeInformation.EnvelopeStatus.SenderIPAddress | string | |
|
Enveloppe envoyée Date-Time
|
DocuSignEnvelopeInformation.EnvelopeStatus.Sent | date-time |
aaaa-MM-ddTHH :mm :ss.fffZ |
|
État de l’enveloppe
|
DocuSignEnvelopeInformation.EnvelopeStatus.Status | string | |
|
Sujet
|
DocuSignEnvelopeInformation.EnvelopeStatus.Subject | string | |
|
Nom de l’expéditeur
|
DocuSignEnvelopeInformation.EnvelopeStatus.UserName | string | |
|
RecipientStatus
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus | array of object | |
|
Tabulations
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.tabs | object |
Paires clé-valeur représentant les onglets de ce destinataire (où la clé est le nom du champ et la valeur est la valeur du champ). |
|
Refuser la raison
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.DeclineReason | DeclineReasonWithoutType | |
|
E-mail du destinataire
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.Email | string | |
|
ID du destinataire
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.RecipientId | string | |
|
Ordre de routage
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.RoutingOrder | string | |
|
Destinataire envoyé Date-Time
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.Sent | date-time |
aaaa-MM-ddTHH :mm :ss.fffZ |
|
État du destinataire
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.Status | string |
État du destinataire. |
|
Type de destinataire
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.Type | string |
Type de destinataire. |
|
Nom du destinataire
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.UserName | string |
Nom du destinataire. |
|
Fuseau horaire
|
DocuSignEnvelopeInformation.TimeZone | string | |
|
Décalage de fuseau horaire
|
DocuSignEnvelopeInformation.TimeZoneOffset | string |
GetDocumentsResponse
- Contenu du fichier
- binary
AddRemindersResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Rappel activé
|
reminderEnabled | string |
Rappel activé |
FilteredEnvelopes
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Titre
|
title | string |
Titre de l’enveloppe |
|
Descriptif
|
description | string |
Description de l’activité d’enveloppe |
|
ID d’enveloppe
|
envelopeId | string |
ID d’enveloppe |
|
Documents
|
documents | string |
Liste des noms de documents |
|
Noms des destinataires
|
recipients | string |
Liste des noms de destinataires |
|
Nom de l’expéditeur
|
sender | string |
Nom de l’expéditeur |
|
Statut
|
status | string |
État de l’enveloppe |
|
Date d’état
|
statusDate | string |
Dernière mise à jour de l’état de l’activité |
|
Date d’envoi
|
dateSent | date-time |
Date d’envoi de l’enveloppe |
|
URL
|
url | string |
URL de l’enveloppe |
EmbeddedSenderResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
URL de l’expéditeur incorporé
|
url | string |
URL de la vue de l’expéditeur incorporé. |
EmbeddedSigningResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
URL
|
url | string |
URL de la vue de signature incorporée. |
FilteredEnvelopeListResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Enveloppes filtrées
|
value | array of FilteredEnvelopes |
Enveloppes filtrées |
|
Autres résultats d’enveloppe
|
hasMoreResults | boolean |
Indique si les enveloppes dépassent le nombre spécifié dans le champ Enveloppes de retour |
CreateEnvelopeResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID d’enveloppe
|
envelopeId | string |
ID de l’enveloppe. |
|
ID de modèle
|
templateId | string |
ID du modèle. |
|
Statut
|
status | string |
État de l’enveloppe. |
|
Heure de la date d’état
|
statusDateTime | string |
Date/heure de la définition de l’état. |
|
URI
|
uri | string |
URI de l’enveloppe dans DocuSign. |
ListRecipientsResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID d’enveloppe
|
envelopeId | string | |
|
Signataires
|
signers | array of Signer |
Signataires |
Onglet
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nom de l’onglet
|
name | string |
Nom de l’onglet. |
|
Type d’onglet
|
tabType | string |
Type de l’onglet. |
|
Étiquette d’onglet
|
tabLabel | string |
Étiquette de l’onglet. |
|
Valeur de l’onglet
|
value | string |
Valeur de l’onglet. |
|
ID de l’onglet
|
tabId | string |
ID de l’onglet. |
|
Document Id
|
documentId | string |
ID du document. |
|
ID du destinataire
|
recipientId | string |
ID du destinataire. |
|
Est prérempli
|
prefill | boolean |
Indique si l’onglet est de type prérempli. |
|
Sélectionné
|
selected | string |
Si les onglets sont cochés, indique si l’onglet est sélectionné. |
RecipientTabsResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Onglet Destinataire :
|
recipientTabs | array of Tab |
Onglet Destinataire |
Signataire
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Ordre de signature
|
routingOrder | string |
Ordre de signature du destinataire dans le document. |
|
Role
|
roleName | string |
Rôle du signataire. |
|
ID du destinataire
|
recipientId | string |
ID du destinataire. |
|
Nom
|
name | string |
Nom du destinataire. |
|
Messagerie électronique
|
string |
E-mail du destinataire. |
|
|
Type de destinataire
|
recipientType | string |
Type du destinataire. |
|
Type de vérification
|
verificationType | string |
Type de vérification. |
|
GUID du destinataire
|
recipientIdGuid | string |
GUID du destinataire. |
GetLoginAccountsResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Comptes de connexion
|
loginAccounts | array of LoginAccount |
Comptes de connexion |
LoginAccount
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nom
|
name | string |
Nom du compte. |
|
Guid de l’ID de compte
|
accountIdGuid | string |
GUID du compte. |
ListTabsResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Tabulations
|
tabs | array of Tab |
Tabulations |
ListEnvelopeDocumentFieldsResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Champ personnalisé
|
envelopeDocumentFields | array of EnvelopeDocumentField |
Champs personnalisés du document |
DocGenFormFieldsResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Champs Docgen
|
docgenFields | array of DocGenFormField |
Champs Docgen |
DocGenFormField
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Document Id
|
documentId | string |
ID de document. |
|
Étiquette
|
label | string |
Étiquette. |
|
Type
|
type | string |
Type. |
|
Nom
|
name | string |
Nom. |
|
Valeur
|
value | string |
Valeur. |
ListTemplatesResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Modèles d’enveloppe
|
envelopeTemplates | array of EnvelopeTemplate |
Modèles d’enveloppe disponibles. |
EnvelopeTemplate
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID de modèle
|
templateId | string |
ID du modèle. |
|
Nom
|
name | string |
Nom du modèle. |
BulkSendListGuid
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Guid de liste d’envoi en bloc
|
listId | string |
Guid de liste d’envoi en bloc |
EnvelopeCustomFieldResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID de champ
|
fieldId | string |
ID du champ personnalisé de l’enveloppe. |
|
Type de champ
|
fieldType | string |
Type du champ personnalisé d’enveloppe. |
|
Nom
|
name | string |
Nom du champ personnalisé d’enveloppe. |
|
Valeur
|
value | string |
Valeur du champ personnalisé de l’enveloppe. |
UpdateEnvelopeCustomFieldResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID de champ
|
fieldId | string |
ID du champ personnalisé de l’enveloppe. |
|
Type de champ
|
fieldType | string |
Type du champ personnalisé d’enveloppe. |
|
Nom
|
name | string |
Nom du champ personnalisé d’enveloppe. |
|
Valeur
|
value | string |
Valeur du champ personnalisé de l’enveloppe. |
ListDocumentsResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Documents d’enveloppe
|
envelopeDocuments | array of EnvelopeDocument |
Documents attachés à l’enveloppe. |
ListTemplateDocumentsResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Documents de modèle
|
templateDocuments | array of EnvelopeDocument |
Documents attachés à un modèle. |
AddDocumentsResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID d’enveloppe
|
envelopeId | string |
ID de l’enveloppe. |
|
Documents d’enveloppe
|
envelopeDocuments | array of EnvelopeDocument |
Documents attachés à l’enveloppe. |
AddRecipientTabsResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Onglets destinataires
|
recipientTabs | array of RecipientTab |
Onglets ajoutés à un destinataire. |
EnvelopeDocument
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nom
|
name | string |
Nom du document. |
|
Document Id
|
documentId | string |
ID du document. |
|
Document Guid
|
documentIdGuid | string |
Guid du document. |
RecipientTab
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID de l’onglet
|
tabId | string |
ID de l’onglet. |
|
Type d’onglet
|
tabType | string |
Type de l’onglet. |
EnvelopeDocumentField
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nom
|
name | string |
Nom du champ personnalisé. |
|
Valeur
|
value | string |
Valeur du champ personnalisé. |
DeclineReasonWithoutType
objet
Il s’agit du type 'object'.