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. Tous les documents d’un environnement de démonstration DocuSign ne sont pas légalement contraignants. Pour toutes les utilisations non-démonstration, utilisez 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.
Obtention des informations d’identification
Pour essayer le connecteur, utilisez un compte DEMO :
- Accédez à https://developers.docusign.com/
- Créez un compte sandbox.
Ces versions sont différentes des versions d’évaluation gratuites dans lesquelles elles n’expirent jamais, ont 90% de nos fonctionnalités de compte payant, et aucun des documents envoyés via DEMO n’est juridiquement contraignant ((https://support.docusign.com/en/articles/Free-account-vs-Developer-account).
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.
Limites de limitation
| 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 |
| Copilot : Obtenir des activités connexes |
Cette action permet d’obtenir des informations supplémentaires sur les ventes liées à un enregistrement CRM qui seront affichées dans la fiche récapitulative de l’enregistrement C4S. L’action améliore les compétences existantes du copilote au sein des ventes. |
| Copilot : Obtenir des enregistrements connexes |
Cette action obtient des enregistrements liés à un enregistrement CRM. L’action améliore les compétences existantes de Copilot for Sales. |
| Copilot : 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. |
| Copilot for Sales : Get email summary |
Cette action obtient des informations supplémentaires sur les ventes qui seront affichées dans l’expérience de résumé de courrier électronique C4S dans le résumé Outlook. L’action améliore les compétences existantes du copilote au sein des ventes. |
| Copilot for Sales : Get key sales |
Cette action obtient des insights supplémentaires sur les ventes qui seront affichés dans la carte d’informations de vente clé C4S dans outlook sidecar. L’action améliore les compétences existantes de copilote pour les ventes |
| Copilot for Sales : List envelopes |
Copilot for Sales : Les enveloppes de liste retournent des informations sur les contrats Docusign tels que le titre, les documents, les destinataires, l’état du contrat, le nom de l’expéditeur et l’URL du contrat. Le plug-in peut gérer les demandes comme m’afficher tous mes contrats que j’ai besoin de signer ou quel est l’état du contrat de commande client. |
| Créer une enveloppe |
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 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ÉCONSEILLÉ : Ajouter un destinataire à une enveloppe |
Ajoutez le destinataire à une enveloppe. |
| DÉCONSEILLÉ : Créer une enveloppe à l’aide d’un modèle |
Créez une enveloppe à l’aide d’un modèle spécifié. |
| DÉCONSEILLÉ : 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. |
| DÉCONSEILLÉ : Obtenir des documents à partir de l’enveloppe |
Obtenir des documents à partir de l’enveloppe |
| Démarrer le flux de travail Docusign Maestro |
Démarrer le flux de travail Docusign Maestro |
| 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 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 de champ personnalisées à partir de l’enveloppe |
Obtenir des informations de champ personnalisées à partir de l’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 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 de l’enveloppe |
Répertorier les destinataires de l’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 |
Retourne
- response
- object
Ajouter des documents à une enveloppe
Ajoutez des documents à une enveloppe.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Compte
|
accountId | True | string |
ID de compte |
|
Enveloppe
|
envelopeId | True | string |
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 |
Retourne
- 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 |
|---|---|---|---|---|
|
Compte
|
accountId | True | string |
ID de compte |
|
Enveloppe
|
envelopeId | True | string |
ID d’enveloppe |
|
Recipient
|
recipientId | True | string |
ID du 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é. |
Retourne
- Corps
- AddRecipientTabsResponse
Ajouter des rappels pour une enveloppe
Ajouter des rappels pour une enveloppe
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Compte
|
accountId | True | string |
ID de compte |
|
Enveloppe
|
envelopeId | True | string |
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. |
Retourne
- Corps
- AddRemindersResponse
Ajouter un destinataire à une enveloppe (V2)
Ajoutez le destinataire à une enveloppe.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Compte
|
accountId | True | string |
ID de compte |
|
Enveloppe
|
envelopeId | True | string |
ID d’enveloppe |
|
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 | integer |
Pour les notifications SMS, le code du pays, sans signe + de début. |
|
|
Numéro de téléphone SMS
|
phoneNumber | integer |
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é. |
Retourne
- 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 |
|---|---|---|---|---|
|
Compte
|
accountId | True | string |
ID de compte |
|
Enveloppe
|
envelopeId | True | string |
ID d’enveloppe |
|
ID du destinataire
|
recipientId | True | string |
ID du destinataire |
|
Type de destinataire
|
recipientType | True | string |
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 |
|---|---|---|---|---|
|
Compte
|
accountId | True | string |
ID de compte |
|
ID d’enveloppe
|
envelopeId | True | string |
ID d’enveloppe |
|
Template
|
templateId | True | string |
Template |
|
Conserver le destinataire du modèle
|
preserve_template_recipient | string |
Faux |
|
|
Document ID
|
documentId | True | string |
Document ID |
|
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
Copilot : Obtenir des activités connexes
Cette action permet d’obtenir des informations supplémentaires sur les ventes liées à un enregistrement CRM qui seront affichées dans la fiche récapitulative de l’enregistrement C4S. L’action améliore les compétences existantes du copilote au sein des ventes.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Type d’enregistrement
|
recordType | True | string |
Cette entrée indique le type d’entité ou d’objet dans CRM pour lequel des informations associées sont demandées. |
|
ID d’enregistrement
|
recordId | True | string |
Cette entrée fournit l’identifiant unique de l’enregistrement de CRM pour lequel les informations sont demandées. |
|
Date de début
|
startDateTime | date-time |
Cette entrée indique la date et l’heure de début des informations demandées. |
|
|
Date de fin
|
endDateTime | date-time |
Cette entrée indique la date et l’heure de fin des informations demandées. |
|
|
Haut
|
top | integer |
Cette entrée indique le nombre d’informations à récupérer. |
|
|
Ignorer
|
skip | integer |
Cette entrée indique le nombre d’informations à ignorer. |
|
|
Type CRM
|
crmType | string |
Cette entrée indique le type de CRM dans lequel existe l’enregistrement CRM, pour lequel les informations sont demandées. |
|
|
URL de l’organisation CRM
|
crmOrgUrl | string |
Cette entrée indique l’URL de l’environnement de CRM dans lequel existe l’enregistrement CRM, pour lequel les informations sont demandées. |
Retourne
Copilot : Obtenir des enregistrements connexes
Cette action obtient des enregistrements liés à un enregistrement CRM. L’action améliore les compétences existantes de Copilot for Sales.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Type d’enregistrement
|
recordType | True | string |
Cette entrée identifie le type d’enregistrement dans CRM pour lequel les enregistrements associés sont demandés. |
|
ID d’enregistrement
|
recordId | True | string |
Cette entrée fournit l’identificateur unique de l’enregistrement CRM pour lequel les enregistrements associés sont demandés. |
|
Date de début
|
startDateTime | date-time |
Entrez la date de début au format : 2017-05-02T01:44Z |
|
|
Haut
|
top | integer |
Cette entrée indique le nombre d’enregistrements associés à extraire. |
|
|
Ignorer
|
skip | integer |
Cette entrée indique le nombre d’enregistrements à ignorer lors de l’extraction d’enregistrements associés. |
|
|
Type CRM
|
crmType | string |
Cette entrée indique le type de CRM à partir duquel sont extraits les enregistrements associés. |
|
|
URL de l’organisation CRM
|
crmOrgUrl | string |
Cette entrée indique l’URL de l’environnement CRM à partir de laquelle les enregistrements associés sont extraits. |
Retourne
Copilot : 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 |
|---|---|---|---|---|
|
Nom du destinataire
|
recipientName | string |
Cette action répertorie les enveloppes en fonction du nom du destinataire |
|
|
EmailId du destinataire
|
recipientEmailId | string |
Cette action répertorie les enveloppes basées sur l’ID de messagerie du destinataire |
|
|
Objet de l’enveloppe
|
envelopeTitle | string |
Cette action répertorie les enveloppes en fonction de l’objet de l’e-mail de l’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 |
Cette action répertorie les enveloppes en fonction d’une valeur de ses 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 |
Cette action répertorie les enveloppes basées sur différents états de l’enveloppe |
|
|
Commande par
|
order_by | string |
Cette action commande des enveloppes basées sur une propriété spécifique |
|
|
Haut
|
top | integer |
Enveloppes supérieures à renvoyer |
|
|
Ignorer
|
skip | integer |
Enveloppes à ignorer |
|
|
Date de début
|
from_date | date-time |
Entrez « » lorsqu’aucune valeur n’est fournie par l’utilisateur. Entrez l’heure de début dans le modèle ou le format : 2017-05-02T01:44Z. |
|
|
Date de fin
|
to_date | date-time |
Entrez « » lorsqu’aucune valeur n’est fournie par l’utilisateur. Entrez l’heure de fin dans le modèle ou le format : 2017-05-02T01:44Z. |
Retourne
Copilot for Sales : Get email summary
Cette action obtient des informations supplémentaires sur les ventes qui seront affichées dans l’expérience de résumé de courrier électronique C4S dans le résumé Outlook. L’action améliore les compétences existantes du copilote au sein des ventes.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Type d’enregistrement
|
recordType | string |
Cette entrée identifie le type d’enregistrement dans CRM lié à l’e-mail résumé. |
|
|
ID d’enregistrement
|
recordId | string |
Cette entrée fournit l’identificateur unique de l’enregistrement CRM lié à l’e-mail résumé. |
|
|
Type CRM
|
crmType | string |
Cette entrée indique le type de CRM dans lequel l’enregistrement lié à l’e-mail résumé existe. |
|
|
URL de l’organisation CRM
|
crmOrgUrl | string |
Cette entrée indique l’URL de l’environnement CRM dans lequel l’enregistrement lié à l’e-mail résumé existe. |
|
|
Adresses e-mail séparées par des virgules
|
emailContacts | True | string |
Cette entrée indique la liste de tous les e-mails de participants pertinents dans le thread de messagerie actuel. |
|
Haut
|
top | integer |
Cette entrée indique le nombre d’informations à récupérer. |
|
|
Ignorer
|
skip | integer |
Cette entrée indique le nombre d’éléments à ignorer lors de l’extraction d’insights. |
Retourne
- Corps
- EmailSummaryResponse
Copilot for Sales : Get key sales
Cette action obtient des insights supplémentaires sur les ventes qui seront affichés dans la carte d’informations de vente clé C4S dans outlook sidecar. L’action améliore les compétences existantes de copilote pour les ventes
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Type d’enregistrement
|
recordType | True | string |
Cette entrée identifie le type d’enregistrement dans CRM pour lequel les informations de vente clés sont demandées. |
|
ID d’enregistrement
|
recordId | True | string |
Cette entrée fournit l’identificateur unique de l’enregistrement CRM pour lequel des informations de vente clés sont demandées. |
|
Date de début
|
startDateTime | date-time |
Entrez la date de début au format : 2017-05-02T01:44Z |
|
|
Haut
|
top | integer |
Cette entrée indique le nombre d'éléments marquants des ventes à récupérer. |
|
|
Ignorer
|
skip | integer |
Cette entrée indique le nombre d’éléments à ignorer lors de l'extraction des points forts des ventes. |
|
|
Type CRM
|
crmType | string |
Cette entrée indique le type de CRM dans lequel l’enregistrement CRM existe, pour lequel les informations de vente clés sont demandées. |
|
|
URL de l’organisation CRM
|
crmOrgUrl | string |
Cette entrée indique l’URL de l’environnement CRM dans lequel l’enregistrement CRM existe, pour lequel les informations de vente clés sont demandées. |
Retourne
- Corps
- KeySalesResponse
Copilot for Sales : List envelopes
Copilot for Sales : Les enveloppes de liste retournent des informations sur les contrats Docusign tels que le titre, les documents, les destinataires, l’état du contrat, le nom de l’expéditeur et l’URL du contrat. Le plug-in peut gérer les demandes comme m’afficher tous mes contrats que j’ai besoin de signer ou quel est l’état du contrat de commande client.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nom du destinataire
|
recipientName | string |
Cette action répertorie les enveloppes en fonction du nom du destinataire |
|
|
EmailId du destinataire
|
recipientEmailId | string |
Cette action répertorie les enveloppes basées sur l’ID de messagerie du destinataire |
|
|
Objet de l’enveloppe
|
envelopeTitle | string |
Cette action répertorie les enveloppes en fonction de l’objet de l’e-mail de l’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 |
Cette action répertorie les enveloppes en fonction d’une valeur de ses 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 |
Cette action répertorie les enveloppes basées sur différents états de l’enveloppe |
|
|
Commande par
|
order_by | string |
Cette action commande des enveloppes basées sur une propriété spécifique |
|
|
Haut
|
top | integer |
Enveloppes supérieures à renvoyer |
|
|
Ignorer
|
skip | integer |
Enveloppes à ignorer |
|
|
Date de début
|
startDateTime | date-time |
Entrez la date de début au format : 2017-05-02T01:44Z |
|
|
Date de fin
|
endDateTime | date-time |
Entrez la date de fin au format : 2017-05-02T01:44Z |
Retourne
Créer une enveloppe
Créez une enveloppe vide.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Compte
|
accountId | True | string |
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. |
|
|
Champs personnalisés
|
accountCustomFields | dynamic |
Obtenez les champs personnalisés définis au niveau du compte. |
Retourne
- 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 |
|---|---|---|---|---|
|
Compte
|
accountId | True | string |
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 |
|
body
|
body | dynamic |
Retourne
| Nom | Chemin | 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 |
|---|---|---|---|---|
|
Compte
|
accountId | True | string |
ID de compte |
|
Template
|
templateId | True | string |
ID de modèle |
|
État de l’enveloppe
|
status | True | string |
État de l’enveloppe |
Retourne
- 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 |
|---|---|---|---|---|
|
Compte
|
accountId | True | string |
ID de compte |
|
Template
|
templateId | True | string |
ID de modèle |
|
Destinataires
|
recipients | dynamic |
Signataires du document. |
|
|
Sujet de l’e-mail
|
emailSubject | string |
Sujet de l’e-mail |
Retourne
- 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 |
|---|---|---|---|---|
|
Compte
|
accountId | True | string |
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 |
Retourne
- Corps
- BulkSendListGuid
DÉCONSEILLÉ : Ajouter un destinataire à une enveloppe
Ajoutez le destinataire à une enveloppe.
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. |
Retourne
- Corps
- ListRecipientsResponse
DÉCONSEILLÉ : 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 |
|---|---|---|---|---|
|
Compte
|
accountId | True | string |
ID de compte |
|
Template
|
templateId | True | string |
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. |
Retourne
- Corps
- CreateEnvelopeResponse
DÉCONSEILLÉ : 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 |
|---|---|---|---|---|
|
Compte
|
accountId | True | string |
ID de compte |
|
État de l’enveloppe
|
status | True | string |
État de l’enveloppe |
|
Template
|
templateId | True | string |
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 |
Retourne
- Corps
- CreateEnvelopeResponse
DÉCONSEILLÉ : Obtenir des documents à partir de l’enveloppe
Obtenir des documents à partir de l’enveloppe
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Compte
|
accountId | True | string |
ID de compte |
|
Enveloppe
|
envelopeId | True | string |
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. |
Retourne
- response
- GetDocumentsResponse
Démarrer le flux de travail Docusign Maestro
Démarrer le flux de travail Docusign Maestro
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Compte
|
accountId | True | string |
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 flux de travail Maestro |
|
variable
|
variable | dynamic |
Retourne
TriggerMaestroFlowResponse
- response
- object
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 |
|---|---|---|---|---|
|
Compte
|
accountId | True | string |
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 |
Retourne
- Corps
- BulkSendListGuid
Envoyer une enveloppe
Envoyez une enveloppe existante.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Compte
|
accountId | True | string |
ID de compte |
|
Enveloppe
|
envelopeId | True | string |
ID d’enveloppe |
Retourne
- 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 |
|---|---|---|---|---|
|
Compte
|
accountId | True | string |
ID de compte |
|
Enveloppe
|
envelopeId | True | string |
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. |
Retourne
- 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 |
|---|---|---|---|---|
|
Compte
|
accountId | True | string |
ID de compte |
|
Enveloppe
|
envelopeId | True | string |
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. |
Retourne
- 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 |
|---|---|---|---|---|
|
Compte
|
accountId | True | string |
ID de compte |
|
Enveloppe
|
envelopeId | True | string |
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. |
Retourne
- 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 |
|---|---|---|---|---|
|
Compte
|
accountId | True | string |
ID de compte |
|
Enveloppe
|
envelopeId | True | string |
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 |
Retourne
Mettre à jour le destinataire sur une enveloppe
Mettre à jour le destinataire sur une enveloppe
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Compte
|
accountId | True | string |
ID de compte |
|
Enveloppe
|
envelopeId | True | string |
ID d’enveloppe |
|
ID du destinataire
|
recipientId | True | string |
ID du 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 | integer |
Pour les notifications SMS, le code du pays, sans signe + de début. |
|
|
Numéro de téléphone SMS
|
phoneNumber | integer |
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é. |
Retourne
- 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 |
|---|---|---|---|---|
|
Compte
|
accountId | True | string |
ID de compte |
|
Enveloppe
|
envelopeId | True | string |
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 |
|
|
: 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 |
|---|---|---|---|---|
|
Compte
|
accountId | True | string |
ID de compte |
|
Enveloppe
|
envelopeId | True | string |
ID d’enveloppe |
|
ID de document
|
documentId | True | string |
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 |
|---|---|---|---|---|
|
Compte
|
accountId | True | string |
ID de compte |
|
Enveloppe
|
envelopeId | True | string |
ID d’enveloppe |
|
Recipient
|
recipientId | True | string |
ID du 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 |
|---|---|---|---|---|
|
Compte
|
accountId | True | string |
ID de compte |
Retourne
- 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 |
|---|---|---|---|---|
|
Compte
|
accountId | True | string |
ID de compte |
|
Enveloppe
|
envelopeId | True | string |
ID d’enveloppe |
Retourne
- Corps
- DocGenFormFieldsResponse
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 |
|---|---|---|---|---|
|
Compte
|
accountId | True | string |
ID de compte |
|
Enveloppe
|
envelopeId | True | string |
ID d’enveloppe |
|
ID de document
|
documentId | True | string |
ID de document |
Retourne
Obtenir des documents à partir d’une enveloppe
Obtenir des documents à partir d’une enveloppe
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Compte
|
accountId | True | string |
ID de compte |
|
Enveloppe
|
envelopeId | True | string |
ID d’enveloppe |
|
Format de sortie
|
documentId | True | string |
Fournissez un ID de document spécifique ou utilisez un format de sortie à partir de la liste déroulante |
Retourne
- response
- GetDocumentsResponse
Obtenir des informations de champ personnalisées à partir de l’enveloppe
Obtenir des informations de champ personnalisées à partir de l’enveloppe
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Compte
|
accountId | True | string |
ID de compte |
|
Enveloppe
|
envelopeId | True | string |
ID d’enveloppe |
|
Nom de champ personnalisé
|
fieldName | True | string |
Nom de champ personnalisé |
Retourne
Obtenir des informations pour l’onglet destinataire
Retourne la valeur de l’onglet pour le destinataire donné
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Compte
|
accountId | True | string |
ID de compte |
|
Enveloppe
|
envelopeId | True | string |
ID d’enveloppe |
|
ID du destinataire
|
recipientId | True | string |
ID du destinataire |
|
Étiquette d’onglet
|
tabLabel | True | string |
Étiquette d’onglet |
Retourne
- 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 |
|---|---|---|---|---|
|
Compte
|
accountId | True | string |
ID de compte |
|
Enveloppe
|
envelopeId | True | string |
ID d’enveloppe |
|
Nom du document
|
documentName | True | string |
Nom de fichier avec extension |
Retourne
- 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 |
|---|---|---|---|---|
|
Compte
|
accountId | True | string |
ID de compte |
|
Enveloppe
|
envelopeId | True | string |
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 |
Recipinet Id |
Retourne
- 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 |
|---|---|---|---|---|
|
Compte
|
accountId | True | string |
ID de compte |
|
Enveloppe
|
envelopeId | True | string |
ID d’enveloppe |
|
ID de document
|
documentId | True | string |
ID de document |
Retourne
- 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 |
|---|---|---|---|---|
|
Compte
|
accountId | True | string |
ID de compte |
|
Template
|
templateId | True | string |
ID de modèle |
|
ID de document
|
documentId | True | string |
ID de document |
Retourne
- 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 |
|---|---|---|---|---|
|
Compte
|
accountId | True | string |
ID de compte |
|
Enveloppe
|
envelopeId | True | string |
ID d’enveloppe |
Retourne
- response
- object
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 |
|---|---|---|---|---|
|
Compte
|
accountId | True | string |
ID de compte |
|
Enveloppe
|
envelopeId | True | string |
ID d’enveloppe |
|
ID du destinataire
|
recipientId | True | string |
ID du destinataire |
Retourne
- 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 |
|---|---|---|---|---|
|
Enveloppe
|
envelopeId | True | string |
ID d’enveloppe |
Retourne
- response
- object
Répertorier les destinataires de l’enveloppe
Répertorier les destinataires de l’enveloppe
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Compte
|
accountId | True | string |
ID de compte |
|
Dossier
|
folderId | True | string |
ID de dossier |
|
Enveloppe
|
envelopeId | True | string |
ID d’enveloppe |
Retourne
- 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 |
|---|---|---|---|---|
|
Compte
|
accountId | True | string |
ID de compte |
|
Template
|
templateId | True | string |
ID de modèle |
Retourne
Répertorier les documents à partir d’une enveloppe
Répertorier les documents à partir d’une enveloppe
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Compte
|
accountId | True | string |
ID de compte |
|
Enveloppe
|
envelopeId | True | string |
ID d’enveloppe |
Retourne
- 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 |
|---|---|---|---|---|
|
Compte
|
accountId | True | string |
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 |
|
|
É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. |
Retourne
Supprimer le destinataire d’une enveloppe
Supprimer le destinataire d’une enveloppe
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Compte
|
accountId | True | string |
ID de compte |
|
Dossier
|
folderId | True | string |
ID de dossier |
|
Enveloppe
|
envelopeId | True | string |
ID d’enveloppe |
|
Recipient
|
RemoveRecipientFromEnvelopeRecipientId | True | string |
ID du destinataire |
Retourne
- Corps
- ListRecipientsResponse
Vider l’enveloppe
Videz l’enveloppe.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Compte
|
accountId | True | string |
ID de compte |
|
Enveloppe
|
envelopeId | True | string |
ID d’enveloppe |
|
Motif void
|
voidedReason | True | string |
Raison annulée |
Retourne
- response
- object
Déclenche
| DÉCONSEILLÉ : Lorsqu’un état de l’enveloppe change (Se connecter) |
Déclenche un nouveau flux lorsqu’un état d’enveloppe change. |
| DÉCONSEILLÉ : Lorsqu’un état de l’enveloppe change (Se connecter) (V2) |
Déclenche un nouveau flux lorsqu’un état d’enveloppe change. |
| Lorsqu’un état d’enveloppe change (Connect) (V3) |
Déclenche un nouveau flux lorsqu’un état d’enveloppe change. |
DÉCONSEILLÉ : Lorsqu’un état de l’enveloppe change (Se connecter)
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 |
Retourne
- Corps
- WebhookEnvelopeResponse
DÉCONSEILLÉ : Lorsqu’un état de l’enveloppe change (Se connecter) (V2)
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 |
Retourne
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 |
Retourne
Définitions
WebhookEnvelopeResponseV2
| Nom | Chemin | 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. |
WebhookEnvelopeResponse
| Nom | Chemin | Type | Description |
|---|---|---|---|
|
Champs personnalisés
|
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 | Type | Description |
|---|---|---|---|
|
Rappel activé
|
reminderEnabled | string |
Rappel activé |
FilteredEnvelopes
| Nom | Chemin | 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 |
SalesCopilotFilteredEnvelopes
| Nom | Chemin | Type | Description |
|---|---|---|---|
|
Titre
|
title | string |
Titre de l’enveloppe |
|
Sous-titre
|
subTitle | string |
Sous-titre de l’enveloppe |
|
URL
|
url | string |
URL de l’enveloppe |
|
Propriétés supplémentaires
|
additionalPropertiesForSalesEnvelope.additionalPropertiesForSalesEnvelope | string |
Propriétés supplémentaires |
Activity
| Nom | Chemin | Type | Description |
|---|---|---|---|
|
Titre
|
title | string |
Cette sortie indique le titre de l’activité dans la carte de citation. |
|
Descriptif
|
description | string |
Cette sortie indique la description de l’aperçu. |
|
Date et heure
|
dateTime | date-time |
Cette sortie indique l’heure associée à l’insight. |
|
URL
|
url | string |
Cette sortie indique l’URL pour ouvrir l’aperçu. |
|
Propriétés supplémentaires
|
additionalProperties.additionalProperties | string |
Propriétés supplémentaires de l’activité |
EmailSummary
| Nom | Chemin | Type | Description |
|---|---|---|---|
|
Titre
|
Title | string |
Cette sortie indique le titre de la section partenaire et doit inclure uniquement le nom du partenaire. |
|
descriptif
|
Description | string |
Ce résultat indique le texte que vous souhaitez inclure dans le résumé du courrier électronique. |
KeySales
| Nom | Chemin | Type | Description |
|---|---|---|---|
|
Titre
|
Title | string |
Ce résultat indique le titre de la carte de citation pour l'aperçu. |
|
descriptif
|
description | string |
Ce résultat indique le texte de l'aperçu à inclure dans les informations clés sur les ventes. |
|
URL de l’enveloppe
|
url | string |
Ce résultat indique l’URL pour en savoir plus sur l’aperçu. |
|
Temps associé à l’insight
|
dateTime | string |
Cette sortie indique l’heure associée à l’insight. |
|
Propriétés supplémentaires
|
additionalProperties.additionalProperties | string |
Cette sortie indique des propriétés supplémentaires sous la forme de paires nom-valeur de chaque information associée retournée par l’action. |
DocumentRecord
| Nom | Chemin | Type | Description |
|---|---|---|---|
|
ID d’enregistrement
|
recordId | string |
Cette sortie identifie de manière unique chaque enregistrement associé retourné par l’action. |
|
Nom complet du type d’enregistrement
|
recordTypeDisplayName | string |
Cette sortie indique le nom complet du type d’enregistrement de chaque enregistrement associé retourné par l’action. |
|
Nom complet du type d’enregistrement au pluriel
|
recordTypePluralDisplayName | string |
Cette sortie indique le nom complet pluriel du type d’enregistrement de chaque enregistrement associé retourné par l’action. |
|
Type d’enregistrement
|
recordType | string |
Cette sortie indique le type de chaque enregistrement associé retourné par l’action. |
|
Titre de l’enregistrement
|
recordTitle | string |
Cette sortie indique le titre de chaque enregistrement associé retourné par l’action. |
|
URL de l’enveloppe
|
url | string |
Cette sortie indique l’URL de chaque enregistrement associé retourné par l’action. |
|
Propriétés supplémentaires
|
additionalProperties.additionalProperties | string |
Cette sortie indique des propriétés supplémentaires sous forme de paires nom-valeur de chaque enregistrement associé retourné par l’action. |
EmbeddedSenderResponse
| Nom | Chemin | Type | Description |
|---|---|---|---|
|
URL de l’expéditeur incorporé
|
url | string |
URL de la vue de l’expéditeur incorporé. |
EmbeddedSigningResponse
| Nom | Chemin | Type | Description |
|---|---|---|---|
|
URL
|
url | string |
URL de la vue de signature incorporée. |
FilteredEnvelopeListResponse
| Nom | Chemin | 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 |
FilteredSalesCopilotEnvelopeListResponse
| Nom | Chemin | Type | Description |
|---|---|---|---|
|
Enveloppes filtrées
|
value | array of SalesCopilotFilteredEnvelopes |
Enveloppes filtrées |
|
aPlusDeRésultats
|
hasMoreResults | boolean |
ActivityListResponseEnvelope
| Nom | Chemin | Type | Description |
|---|---|---|---|
|
Activités connexes
|
value | array of Activity |
Activités connexes |
|
aPlusDeRésultats
|
hasMoreResults | boolean |
EmailSummaryResponse
| Nom | Chemin | Type | Description |
|---|---|---|---|
|
Résumé d’e-mail
|
value | array of EmailSummary |
Ventes clés |
|
aPlusDeRésultats
|
hasMoreResults | boolean |
KeySalesResponse
| Nom | Chemin | Type | Description |
|---|---|---|---|
|
Ventes clés'
|
value | array of KeySales |
Ventes clés |
|
aPlusDeRésultats
|
hasMoreResults | boolean |
DocumentRecordListResponseEnvelope
| Nom | Chemin | Type | Description |
|---|---|---|---|
|
Enregistrements connexes
|
value | array of DocumentRecord |
Enregistrements connexes |
|
aPlusDeRésultats
|
hasMoreResults | boolean |
CreateEnvelopeResponse
| Nom | Chemin | 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 | Type | Description |
|---|---|---|---|
|
Signataires
|
signers | array of Signer |
Signataires |
Onglet
| Nom | Chemin | 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 | Type | Description |
|---|---|---|---|
|
Onglet Destinataire :
|
recipientTabs | array of Tab |
Onglet Destinataire |
Signataire
| Nom | Chemin | 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 | Type | Description |
|---|---|---|---|
|
Comptes de connexion
|
loginAccounts | array of LoginAccount |
Comptes de connexion |
LoginAccount
| Nom | Chemin | Type | Description |
|---|---|---|---|
|
Nom
|
name | string |
Nom du compte. |
|
Guid de l’ID de compte
|
accountIdGuid | string |
GUID du compte. |
ListTabsResponse
| Nom | Chemin | Type | Description |
|---|---|---|---|
|
Tabulations
|
tabs | array of Tab |
Tabulations |
ListEnvelopeDocumentFieldsResponse
| Nom | Chemin | Type | Description |
|---|---|---|---|
|
Champ personnalisé
|
envelopeDocumentFields | array of EnvelopeDocumentField |
Champs personnalisés du document |
DocGenFormFieldsResponse
| Nom | Chemin | Type | Description |
|---|---|---|---|
|
Champs Docgen
|
docgenFields | array of DocGenFormField |
Champs Docgen |
DocGenFormField
| Nom | Chemin | 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 | Type | Description |
|---|---|---|---|
|
Modèles d’enveloppe
|
envelopeTemplates | array of EnvelopeTemplate |
Modèles d’enveloppe disponibles. |
EnvelopeTemplate
| Nom | Chemin | Type | Description |
|---|---|---|---|
|
ID de modèle
|
templateId | string |
ID du modèle. |
|
Nom
|
name | string |
Nom du modèle. |
BulkSendListGuid
| Nom | Chemin | Type | Description |
|---|---|---|---|
|
Guid de liste d’envoi en bloc
|
listId | string |
Guid de liste d’envoi en bloc |
EnvelopeCustomFieldResponse
| Nom | Chemin | 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 | 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 | Type | Description |
|---|---|---|---|
|
Documents d’enveloppe
|
envelopeDocuments | array of EnvelopeDocument |
Documents attachés à l’enveloppe. |
ListTemplateDocumentsResponse
| Nom | Chemin | Type | Description |
|---|---|---|---|
|
Documents de modèle
|
templateDocuments | array of EnvelopeDocument |
Documents attachés à un modèle. |
AddDocumentsResponse
| Nom | Chemin | 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 | Type | Description |
|---|---|---|---|
|
Onglets destinataires
|
recipientTabs | array of RecipientTab |
Onglets ajoutés à un destinataire. |
EnvelopeDocument
| Nom | Chemin | 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 | Type | Description |
|---|---|---|---|
|
ID de l’onglet
|
tabId | string |
ID de l’onglet. |
|
Type d’onglet
|
tabType | string |
Type de l’onglet. |
EnvelopeDocumentField
| Nom | Chemin | Type | Description |
|---|---|---|---|
|
Nom
|
name | string |
Nom du champ personnalisé. |
|
Valeur
|
value | string |
Valeur du champ personnalisé. |
DeclineReasonWithoutType
objet
Il s’agit du type 'object'.