GetAccept
GetAccept fournit une plateforme d’activation des ventes pour la conception, l’envoi, la promotion, la promotion, le suivi et la signature électronique des documents de vente, en tirant parti des garanties commerciales, de la gestion des contrats, des propositions et des signatures électroniques dans un seul endroit.
Ce connecteur est disponible dans les produits et régions suivants :
| Service | classe | Régions |
|---|---|---|
| Copilot Studio | Premium | Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Applications logiques | Norme | Toutes les régions Logic Apps , à l’exception des suivantes : - Régions Azure Government - Régions Azure Chine - Us Department of Defense (DoD) |
| Power Apps | Premium | Toutes les régions Power Apps , à l’exception des suivantes : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Power Automate | Premium | Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Contact | |
|---|---|
| Nom | GetAccept API Team |
| URL | https://app.getaccept.com/api |
| Messagerie électronique | integrations@getaccept.com |
| Métadonnées du connecteur | |
|---|---|
| Éditeur | GetAccept, Inc. |
| Site internet | https://www.getaccept.com |
| Politique de confidentialité | https://www.getaccept.com/privacy-policy |
| Catégories | Ventes et CRM ; Productivité |
GetAccept fournit une plateforme d’activation des ventes pour la conception, l’envoi, la promotion, la promotion, le suivi et la signature électronique des documents de vente, en tirant parti des garanties commerciales, de la gestion des contrats, des propositions et des signatures électroniques dans un seul endroit. Ce connecteur permet d’automatiser vos flux de travail pour le stockage de documents, la récupération, l’attribution de tâches et les notifications personnalisées.
Prerequisites
Un compte GetAccept est requis pour utiliser cette connexion. Accédez à getaccept.com pour inscrire un compte gratuit.
Comment obtenir des informations d’identification ?
Seul un compte GetAccept valide est requis, car OAuth2 est utilisé pour authentifier l’utilisateur connecté actuel dans GetAccept.
Problèmes connus et limitations
Veuillez contacter notre [mailto :support@getaccept.com](support technique) pour tout problème lié à l’intégration.
Limitations
| Nom | Appels | Période de renouvellement |
|---|---|---|
| Appels d’API par connexion | 100 | 60 secondes |
Actions
| Charger un fichier de document |
Vous pouvez charger un fichier à la fois et obtenir un ID de fichier. L’ID de fichier est utilisé pour connecter un fichier avec un document GetAccept qui est envoyé aux destinataires. Si vous souhaitez charger des fichiers mutliple, vous exécutez plusieurs fichiers POST. Nous acceptons uniquement les fichiers jusqu’à 10 Mo par défaut. Le fichier chargé doit être importé/ajouté à un document dans un délai de 48 heures après le chargement. Nous vous recommandons de charger des fichiers PDF afin de garantir la même apparence lors de l’envoi. D’autres types de fichiers peuvent être convertis, tels que : Mirosoft Office : doc, docx, xls, xls, xlsx, pptx Mac : nombres, images clés : jpg, jpeg, png Other : html, tex, csv |
| Charger une pièce jointe |
Vous pouvez charger des fichiers de pièce jointe à inclure avec les documents que vous envoyez. La requête réussie retourne le attachment_id. Utilisez attachment_id pour affecter une pièce jointe à un document. |
| Charger une vidéo |
Vous pouvez charger des fichiers de pièce jointe à inclure avec les documents que vous envoyez. La requête réussie retourne le attachment_id. Utilisez attachment_id pour affecter une pièce jointe à un document. |
| Créer contact |
Cela crée un contact dans la base de données pour l’entité actuelle |
| Créer et envoyer un document ou un modèle |
Vous devez créer un document pour pouvoir l’envoyer à un destinataire. Lorsque vous créez un document, vous pouvez faire référence à des fichiers précédemment chargés avec file_id ou vous pouvez choisir de créer un document et de charger les fichiers dans le billet d’API. Vous ne pouvez charger qu’un fichier lors de l’inclusion d’un fichier dans le document POST de création. Utilisez file_ids paramètre pour utiliser des fichiers chargés existants, file_content pour envoyer le document en tant que chaîne encodée en base64 ou effectuer un billet à plusieurs parties avec paramètre de fichier. Tous les destinataires doivent avoir un e-mail valide ou un numéro mobile. Tous les événements sont enregistrés à l’aide de l’adresse IP du demandeur. Vous pouvez remplacer cela à l’aide de l’en-tête CLIENT_IP contenant l’adresse IP publique des utilisateurs finaux. |
| Créer un utilisateur |
Cela crée un contact dans la base de données pour l’entité actuelle |
| Envoyer un document existant |
Lorsque vous envoyez un document via GetAccept, nous fournissons un e-mail à tous les destinataires, chacun contenant un lien unique et sécurisé. Cet appel d’API déclenche l’action d’envoi de document et ne peut être effectué que sur des documents avec document_status = brouillon. Le document sera envoyé aux destinataires que vous avez fournis lors de sa création. Si le document a été créé à l’aide de l’option de signature automatique, il est également auto-signé par l’utilisateur authentifié ou spécifié avant d’envoyer. |
| Mettre à jour l’expiration du document |
Utilisez cette méthode pour mettre à jour la date et l’heure d’expiration d’un document. |
| Modèles de liste |
Recevez la liste des modèles de documents disponibles. Vous pouvez ajouter de nouveaux modèles sous la section Modèles dans GetAccept. |
| Obtenir des champs de document |
Obtenez la liste des champs d’un document ou d’un modèle. Peut être utilisé avant et après la signature d’un document. |
| Obtenir des champs de modèle |
Recevez une liste de champs pour un modèle spécifique. |
| Obtenir des pièces jointes de document |
Obtenez des pièces jointes de document en spécifiant un ID de document. |
| Obtenir des rôles de modèle |
Recevez une liste de rôles pour un modèle spécifique. |
| Obtenir des tables de tarification de modèle |
Recevez une liste d’éléments de table de tarification pour un modèle spécifique. |
| Obtenir les destinataires du document |
Obtenez la liste des destinataires d’un document spécifique. |
| Obtenir les détails de l’utilisateur |
Cet appel retourne les détails d’un seul utilisateur. Recevoir les détails et les entités disponibles de l’utilisateur authentifié actuel à l’aide de mon ID d’utilisateur |
| Obtenir les détails du document |
Obtenez les détails du document en spécifiant un ID de document. |
| Répertorier des utilisateurs |
Récupérer une liste d’utilisateurs actifs pour l’entité authentifiée actuelle |
| Répertorier les contacts |
Recevez une liste de contacts disponibles pour l’entité actuelle. Tous les contacts ajoutés en tant que destinataire sont enregistrés en tant que contact et sont disponibles pour une utilisation ultérieure sur cette entité. |
| Répertorier les documents |
Obtenir la liste des documents disponibles |
| Répertorier les pièces jointes |
Recevez la liste des pièces jointes disponibles. Vous pouvez ajouter de nouvelles pièces jointes dans GetAccept à l’aide d’un nouveau document. |
| Répertorier les vidéos |
Recevez la liste des vidéos disponibles sur l’entité. Vous pouvez ajouter de nouvelles vidéos dans l’application mobile ou dans GetAccept. |
| Télécharger le document |
Le fichier de document peut toujours être téléchargé, mais il est probable que vous souhaitez le télécharger lorsqu’il a l’état Signé. Vous pouvez choisir de recevoir une URL de téléchargement ou d’obtenir le fichier binaire. L’URL de téléchargement est accessible 10 minutes après la création d’une demande. |
Charger un fichier de document
Vous pouvez charger un fichier à la fois et obtenir un ID de fichier. L’ID de fichier est utilisé pour connecter un fichier avec un document GetAccept qui est envoyé aux destinataires. Si vous souhaitez charger des fichiers mutliple, vous exécutez plusieurs fichiers POST. Nous acceptons uniquement les fichiers jusqu’à 10 Mo par défaut. Le fichier chargé doit être importé/ajouté à un document dans un délai de 48 heures après le chargement.
Nous vous recommandons de charger des fichiers PDF afin de garantir la même apparence lors de l’envoi. D’autres types de fichiers peuvent être convertis, tels que :
Mirosoft Office : doc, docx, xls, xls, xlsx, pptx Mac : nombres, images clés : jpg, jpeg, png Other : html, tex, csv
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Contenu du fichier
|
file_content | string |
Envoyez le fichier encodé en base64. Notez que les fichiers d’encodage base64 augmenteront la taille du fichier avec environ 30% |
|
|
Nom de fichier
|
file_name | string |
Nom de fichier du document, avec l’extension. Cela sera utile pour convertir différents types de fichiers. |
|
|
URL du fichier
|
file_url | string |
URL du fichier de document. Le fichier doit être disponible en téléchargement sans autorisation |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
identifiant_de_fichier
|
file_id | string |
ID du fichier chargé à utiliser dans file_ids lors de la création d’un document |
|
file_status
|
file_status | string |
État du fichier chargé |
Charger une pièce jointe
Vous pouvez charger des fichiers de pièce jointe à inclure avec les documents que vous envoyez. La requête réussie retourne le attachment_id. Utilisez attachment_id pour affecter une pièce jointe à un document.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Contenu du fichier
|
file_content | string |
Envoyez le fichier encodé en base64. Notez que les fichiers d’encodage base64 augmenteront la taille du fichier avec environ 30% |
|
|
Nom de fichier
|
file_name | string |
Nom de fichier du document, avec l’extension. Cela sera utile pour convertir différents types de fichiers. |
|
|
URL du fichier
|
file_url | string |
URL du fichier de document. Le fichier doit être disponible en téléchargement sans autorisation |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nom de fichier
|
filename | string |
Nom de fichier de la pièce jointe |
|
ID de pièce jointe
|
id | string |
ID de la pièce jointe chargée à utiliser dans attachment_id lors de la création d’un document |
|
Titre de pièce jointe
|
title | string |
Titre de la pièce jointe |
|
Type de pièce jointe
|
type | string |
Type de la pièce jointe |
Charger une vidéo
Vous pouvez charger des fichiers de pièce jointe à inclure avec les documents que vous envoyez. La requête réussie retourne le attachment_id. Utilisez attachment_id pour affecter une pièce jointe à un document.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Contenu du fichier
|
file_content | string |
Envoyez le fichier encodé en base64. Notez que les fichiers d’encodage base64 augmenteront la taille du fichier avec environ 30% |
|
|
Nom de fichier
|
file_name | string |
Nom de fichier du document, avec l’extension. Cela sera utile pour convertir différents types de fichiers. |
|
|
URL du fichier
|
file_url | string |
URL du fichier de document. Le fichier doit être disponible en téléchargement sans autorisation |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
État du fichier
|
file_status | string |
État de la vidéo |
|
Nom de fichier
|
filename | string |
Nom de fichier de la vidéo |
|
ID du travail
|
job_id | string |
ID du travail de traitement convertissant et compressant la vidéo. Interrogez les mises à jour de l’état du travail à l’aide de /video/job/<ID>. |
|
ID de vidéo
|
video_id | string |
ID de la vidéo chargée à utiliser dans video_id lors de la création d’un document |
Créer contact
Cela crée un contact dans la base de données pour l’entité actuelle
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nom de l’entreprise
|
company_name | string |
Nom de la société associé |
|
|
Numéro d’entreprise
|
company_number | string |
Numéro d’entreprise associé |
|
|
Messagerie électronique
|
string |
Adresse e-mail du contact |
||
|
Prénom
|
first_name | string |
Prénom du contact |
|
|
Nom complet
|
fullname | string |
Permet de spécifier le nom complet au lieu du prénom/du nom |
|
|
Nom
|
last_name | string |
Nom du contact |
|
|
Téléphone mobile
|
mobile | string |
Numéro de téléphone mobile au format international |
|
|
Note
|
note | string |
Note interne facultative pour le contact |
|
|
Téléphone
|
phone | string |
Numéro de téléphone au format international |
|
|
Titre
|
title | string |
Titre du contact, ex. Pdg, Directeur commercial |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Identifiant de contact
|
contact_id | string |
ID du contact créé |
Créer et envoyer un document ou un modèle
Vous devez créer un document pour pouvoir l’envoyer à un destinataire. Lorsque vous créez un document, vous pouvez faire référence à des fichiers précédemment chargés avec file_id ou vous pouvez choisir de créer un document et de charger les fichiers dans le billet d’API. Vous ne pouvez charger qu’un fichier lors de l’inclusion d’un fichier dans le document POST de création.
Utilisez file_ids paramètre pour utiliser des fichiers chargés existants, file_content pour envoyer le document en tant que chaîne encodée en base64 ou effectuer un billet à plusieurs parties avec paramètre de fichier.
Tous les destinataires doivent avoir un e-mail valide ou un numéro mobile.
Tous les événements sont enregistrés à l’aide de l’adresse IP du demandeur. Vous pouvez remplacer cela à l’aide de l’en-tête CLIENT_IP contenant l’adresse IP publique des utilisateurs finaux.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
ID de pièce jointe reçu à partir de la liste ou après le chargement |
|
|
Exiger l’affichage
|
require_view | boolean |
Exiger que le destinataire affiche la pièce jointe |
|
|
Type
|
type | string |
fichier ou externe où le fichier est un fichier chargé et externe est un lien vers un fichier externe |
|
|
ID de champ
|
id | string |
ID du champ de modèle personnalisé |
|
|
Nom du champ
|
name | string |
Nom du champ de modèle personnalisé |
|
|
Valeur de champ
|
value | string |
Valeur du champ de modèle personnalisé |
|
|
Monnaie
|
currency | string |
Devise, ex. SEK |
|
|
Paramètres régionaux
|
locale | string |
Paramètres régionaux, par exemple sv-SE |
|
|
Nom d’affichage
|
display_name | string |
Nom complet de la table de tarification |
|
|
External ID
|
external_id | string |
ID externe pour représenter l’objet de synthèse au sein d’un système tiers |
|
|
Table ID
|
id | string |
Table ID |
|
|
Totaux précalculés
|
pre_calculated | boolean |
Si les totaux des tables de tarification doivent être précalculés |
|
|
Nom d’affichage
|
display_name | string |
Nom complet de la table de tarification |
|
|
ID
|
id | string |
Section ID |
|
|
Rows
|
rows |
Tableau avec objet valeurs avec tableau de column_id, valeur |
||
|
Enabled
|
enabled | boolean |
Si la remise de section doit être activée |
|
|
Forfait
|
flat_fee | boolean |
Si la section doit utiliser des remises à frais fixes |
|
|
Valeur de remise
|
value | string |
Valeur de la remise de section |
|
|
Enabled
|
enabled | boolean |
Si le prix de section doit être activé |
|
|
Forfait
|
flat_fee | boolean |
Si la section doit utiliser la tarification des frais fixes |
|
|
Valeur de prix
|
value | string |
Valeur du prix de section |
|
|
Enabled
|
enabled | boolean |
Si la taxe de section doit être activée |
|
|
Forfait
|
flat_fee | boolean |
Si la section doit utiliser des taxes forfaitaires |
|
|
Valeur fiscale
|
value | string |
Valeur de la taxe de section |
|
|
Enabled
|
enabled | boolean |
Si la remise de table de tarification doit être activée |
|
|
Forfait
|
flat_fee | boolean |
Si la table de tarification doit utiliser des remises à frais fixes |
|
|
Valeur de remise
|
value | string |
Valeur de la remise récapitulative |
|
|
Enabled
|
enabled | boolean |
Si le prix du tableau de tarification doit être activé |
|
|
Forfait
|
flat_fee | boolean |
Si le tableau de tarification doit utiliser la tarification des frais fixes |
|
|
Valeur de prix
|
value | string |
Valeur du prix résumé |
|
|
Enabled
|
enabled | boolean |
Si la taxe sur la table de tarification doit être activée |
|
|
Forfait
|
flat_fee | boolean |
Si le tableau des prix doit utiliser des taxes forfaitaires |
|
|
Valeur
|
value | string |
Valeur de la taxe récapitulative |
|
|
Date d'expiration
|
expiration_date | date-time |
Date et heure à laquelle le document doit expirer |
|
|
External ID
|
external_id | string |
ID système externe pour l’identification |
|
|
Contenu du fichier
|
file_content | string |
Contenu de fichier encodé en base64 |
|
|
ID de fichier
|
file_ids | string |
Id de fichier unique séparés par des virgules reçus lors du chargement de fichiers |
|
|
Nom de fichier
|
file_name | string |
Nom de fichier du document, avec l’extension. Cela sera utile pour convertir différents types de fichiers. |
|
|
URL du fichier
|
file_url | string |
URL du fichier de document. Les documents doivent être publics à télécharger |
|
|
Envoyer automatiquement
|
is_automatic_sending | boolean |
Si le document doit être envoyé après la création |
|
|
Envoyer des rappels
|
is_reminder_sending | boolean |
Les rappels automatiques doivent-ils être envoyés |
|
|
Planifier l’envoi
|
is_scheduled_sending | boolean |
Si l’envoi doit être planifié pour l’envoi à l’avenir |
|
|
Signer un document
|
is_signing | boolean |
Si le document doit être envoyé pour la signature |
|
|
Signature manuscrite
|
is_signing_biometric | boolean |
Utiliser une signature manuscrite |
|
|
Autoriser le transfert de signature
|
is_signing_forward | boolean |
Les destinataires doivent être en mesure de transférer des droits de signature |
|
|
Signer avec des initiales
|
is_signing_initials | boolean |
Signer un document à l’aide des initiales du destinataire |
|
|
Envoyer un SMS
|
is_sms_sending | boolean |
Le document doit-il être envoyé au destinataire mobile par texte |
|
|
Nom du document
|
name | True | string |
Entrez un nom du document |
|
Nom de la société
|
company_name | string |
Nom de la société du destinataire |
|
|
Numéro d’entreprise
|
company_number | string |
Numéro d’entreprise du destinataire |
|
|
Messagerie électronique
|
string |
Adresse e-mail du destinataire |
||
|
Prénom
|
first_name | string |
Prénom du destinataire |
|
|
Nom
|
last_name | string |
Nom du destinataire |
|
|
Téléphone mobile
|
mobile | string |
Téléphone mobile au format international |
|
|
Note
|
note | string |
Note supplémentaire pour un destinataire |
|
|
Ordre de signature
|
order_num | integer |
Si l’ordre de signature est activé |
|
|
Type de destinataire
|
role | string |
Type de destinataire dans le document |
|
|
Rôle de modèle
|
role_name | string |
Nom du rôle dans un modèle |
|
|
Vérifier EID
|
verify_eid | boolean |
Vérifier à l’aide d’EID |
|
|
Type EID
|
verify_eid_type | string |
Type EID à utiliser pour la vérification personnelle |
|
|
Activer la question
|
verify_qna | boolean |
Si une question doit être posée |
|
|
Réponse de vérification
|
verify_qna_answer | string |
Réponse à la question |
|
|
Question ouverte
|
verify_qna_open | boolean |
Question à poser avant d’ouvrir le document |
|
|
Question de vérification
|
verify_qna_question | string |
Question à poser pour la vérification |
|
|
Question signer
|
verify_qna_sign | boolean |
Si une question doit être posée avant de signer |
|
|
Vérifier sms
|
verify_sms | boolean |
Vérifier le destinataire par SMS |
|
|
Vérifier le SMS ouvert
|
verify_sms_open | boolean |
Vérifier le SMS ouvert |
|
|
Vérifier par SMS
|
verify_sms_sign | boolean |
Si un SMS vérifie le destinataire avant de signer |
|
|
Planification de la date d’envoi
|
scheduled_sending_time | date-time |
Date et heure à laquelle le document doit être envoyé |
|
|
Remplacement de l’e-mail de l’expéditeur
|
sender_email | string |
Envoyer à partir d’un autre e-mail que l’utilisateur authentifié |
|
|
Remplacement de l’utilisateur de l’expéditeur
|
sender_id | string |
Envoyer à partir d’un autre utilisateur que authentifié |
|
|
ID de modèle
|
template_id | string |
Sélectionner un modèle à utiliser pour l’envoi |
|
|
Type de document
|
type | string |
Définir le type/la catégorie du document |
|
|
Valeur du document
|
value | integer |
Valeur de transaction ou de document |
|
|
ID de vidéo
|
video_id | string |
Sélectionner une vidéo à utiliser pour l’envoi |
Retours
Un document est un ou plusieurs fichiers chargés qui doivent être envoyés à un ou plusieurs destinataires créés par un utilisateur.
- Document
- Document
Créer un utilisateur
Cela crée un contact dans la base de données pour l’entité actuelle
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
company_name
|
company_name | string |
Nom de la société associé |
|
|
company_number
|
company_number | string |
Numéro d’entreprise associé |
|
|
Messagerie électronique
|
string |
Adresse e-mail du contact |
||
|
first_name
|
first_name | string |
Prénom du contact |
|
|
fullname
|
fullname | string |
Permet de spécifier le nom complet au lieu du prénom/du nom |
|
|
last_name
|
last_name | string |
Nom du contact |
|
|
mobile
|
mobile | string |
Numéro de téléphone mobile au format international |
|
|
note
|
note | string |
Note interne facultative pour le contact |
|
|
phone
|
phone | string |
Numéro de téléphone au format international |
|
|
title
|
title | string |
Titre du contact, ex. Pdg, Directeur commercial |
Retours
Un utilisateur est défini par son adresse de messagerie et est connecté à une ou plusieurs entités.
Rôles d'utilisateur
Administrateur :
- Afficher tous les documents
- Modifier tous les documents
- Modifier les paramètres d’entité, les informations et la facturation
- Ajouter de nouveaux utilisateurs à l’entité
- Attribuer des rôles d’entité
Gérant:
- Afficher les documents d’équipe
- Modifier tous les documents
- Ajouter de nouveaux utilisateurs à l’entité
Entité
Une entité est le nœud supérieur et tous les utilisateurs et documents correspondants sont connectés à une entité. Une entité est souvent la même qu’une entreprise, un pays ou un service dans une grande organisation.
- Utilisateur
- User
Envoyer un document existant
Lorsque vous envoyez un document via GetAccept, nous fournissons un e-mail à tous les destinataires, chacun contenant un lien unique et sécurisé. Cet appel d’API déclenche l’action d’envoi de document et ne peut être effectué que sur des documents avec document_status = brouillon. Le document sera envoyé aux destinataires que vous avez fournis lors de sa création.
Si le document a été créé à l’aide de l’option de signature automatique, il est également auto-signé par l’utilisateur authentifié ou spécifié avant d’envoyer.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Document ID
|
documentId | True | string |
Document ID |
|
sender_email
|
sender_email |
Utilisez cette option pour spécifier l’utilisateur/le propriétaire de l’expéditeur par adresse e-mail à utiliser pour la signature automatique du document. |
||
|
sender_id
|
sender_id | string |
Utilisez cette option pour spécifier l’utilisateur/propriétaire de l’expéditeur par ID à utiliser pour la signature automatique du document. |
Retours
Un document est un ou plusieurs fichiers chargés qui doivent être envoyés à un ou plusieurs destinataires créés par un utilisateur.
- Document
- Document
Mettre à jour l’expiration du document
Utilisez cette méthode pour mettre à jour la date et l’heure d’expiration d’un document.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Document ID
|
documentId | True | string |
Document ID |
|
Date d'expiration
|
expiration_date | date-time |
Date et heure à laquelle le document doit expirer (UTC) |
|
|
Envoyer une notification
|
send_notification | boolean |
Si une notification concernant la mise à jour doit être envoyée aux destinataires |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Statut
|
status | integer |
État de la mise à jour |
Modèles de liste
Recevez la liste des modèles de documents disponibles. Vous pouvez ajouter de nouveaux modèles sous la section Modèles dans GetAccept.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Afficher tout
|
showall | string |
Afficher tous les modèles pour l’entité |
|
|
ID du dossier
|
folder_id | string |
Afficher les modèles dans un dossier spécifique |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
templates
|
templates | array of object | |
|
tags
|
templates.tags | string | |
|
date_de_création
|
templates.created_at | string | |
|
external_editor_type
|
templates.external_editor_type | string | |
|
field_count
|
templates.field_count | integer | |
|
pièce d'identité
|
templates.id | string | |
|
is_editable
|
templates.is_editable | boolean | |
|
is_private
|
templates.is_private | boolean | |
|
nom
|
templates.name | string | |
|
page_count
|
templates.page_count | integer | |
|
role_count
|
templates.role_count | integer | |
|
sender_name
|
templates.sender_name | string | |
|
sender_thumb_url
|
templates.sender_thumb_url | string | |
|
thumb_url
|
templates.thumb_url | string | |
|
type
|
templates.type | string | |
|
user_id
|
templates.user_id | string | |
|
video_id
|
templates.video_id | string | |
|
video_thumb_url
|
templates.video_thumb_url | string |
Obtenir des champs de document
Obtenez la liste des champs d’un document ou d’un modèle. Peut être utilisé avant et après la signature d’un document.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Document ID
|
documentId | True | string |
Document ID |
Retours
Liste des champs
- Fields
- Fields
Obtenir des champs de modèle
Recevez une liste de champs pour un modèle spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de modèle
|
templateId | True | string |
ID de modèle |
Retours
Liste des champs
- Fields
- Fields
Obtenir des pièces jointes de document
Obtenez des pièces jointes de document en spécifiant un ID de document.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Document ID
|
documentId | True | string |
Document ID |
Retours
Liste de pièces jointes
- Attachments
- Attachments
Obtenir des rôles de modèle
Recevez une liste de rôles pour un modèle spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de modèle
|
templateId | True | string |
ID de modèle |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
roles
|
roles | array of object | |
|
Messagerie électronique
|
roles.email | string | |
|
first_name
|
roles.first_name | string | |
|
last_name
|
roles.last_name | string | |
|
mobile
|
roles.mobile | string | |
|
role
|
roles.role | string | |
|
role_id
|
roles.role_id | string | |
|
role_name
|
roles.role_name | string |
Obtenir des tables de tarification de modèle
Recevez une liste d’éléments de table de tarification pour un modèle spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de modèle
|
templateId | True | string |
ID de modèle |
Retours
Tables de tarification
- Pricing
- PricingTables
Obtenir les destinataires du document
Obtenez la liste des destinataires d’un document spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Document ID
|
documentId | True | string |
Document ID |
Retours
Liste des destinataires
- Destinataires
- Recipients
Obtenir les détails de l’utilisateur
Cet appel retourne les détails d’un seul utilisateur. Recevoir les détails et les entités disponibles de l’utilisateur authentifié actuel à l’aide de mon ID d’utilisateur
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’utilisateur
|
userId | True | string |
ID d’utilisateur |
Retours
Un utilisateur est défini par son adresse de messagerie et est connecté à une ou plusieurs entités.
Rôles d'utilisateur
Administrateur :
- Afficher tous les documents
- Modifier tous les documents
- Modifier les paramètres d’entité, les informations et la facturation
- Ajouter de nouveaux utilisateurs à l’entité
- Attribuer des rôles d’entité
Gérant:
- Afficher les documents d’équipe
- Modifier tous les documents
- Ajouter de nouveaux utilisateurs à l’entité
Entité
Une entité est le nœud supérieur et tous les utilisateurs et documents correspondants sont connectés à une entité. Une entité est souvent la même qu’une entreprise, un pays ou un service dans une grande organisation.
- Utilisateur
- User
Obtenir les détails du document
Obtenez les détails du document en spécifiant un ID de document.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Document ID
|
documentId | True | string |
Document ID |
Retours
Un document est un ou plusieurs fichiers chargés qui doivent être envoyés à un ou plusieurs destinataires créés par un utilisateur.
- Document
- Document
Répertorier des utilisateurs
Récupérer une liste d’utilisateurs actifs pour l’entité authentifiée actuelle
Retours
Liste des utilisateurs
- Users
- Users
Répertorier les contacts
Recevez une liste de contacts disponibles pour l’entité actuelle. Tous les contacts ajoutés en tant que destinataire sont enregistrés en tant que contact et sont disponibles pour une utilisation ultérieure sur cette entité.
Retours
Liste de contacts
- Contacts
- Contacts
Répertorier les documents
Obtenir la liste des documents disponibles
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Liste de filtres sur l’état
|
filter | string |
Liste de filtres sur l’état |
|
|
Comment trier les résultats
|
sort_by | string |
Comment trier les résultats |
|
|
Ordre de tri des résultats
|
sort_order | string |
Ordre de tri des résultats |
|
|
Inclure des documents des membres de l’équipe
|
showteam | boolean |
Inclure des documents des membres de l’équipe |
|
|
Inclure tous les documents de l’entité
|
showall | boolean |
Inclure tous les documents de l’entité |
|
|
External ID
|
external_id | string |
Un ID externe est un champ personnalisé qui peut contenir un identificateur d’enregistrement unique d’un système en dehors de GetAccept |
|
|
Décalage
|
offset | number |
Liste de démarrage de l’enregistrement x jusqu’à la limite |
|
|
Limit
|
limit | number |
Nombre d’enregistrements à répertorier |
Retours
Liste des documents
- Objets
- Documents
Répertorier les pièces jointes
Recevez la liste des pièces jointes disponibles. Vous pouvez ajouter de nouvelles pièces jointes dans GetAccept à l’aide d’un nouveau document.
Retours
Liste de pièces jointes
- Attachments
- Attachments
Répertorier les vidéos
Recevez la liste des vidéos disponibles sur l’entité. Vous pouvez ajouter de nouvelles vidéos dans l’application mobile ou dans GetAccept.
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
videos
|
videos | array of object | |
|
modifiable
|
videos.editable | boolean | |
|
publié
|
videos.published | boolean | |
|
sauvé
|
videos.saved | boolean | |
|
thumb_url
|
videos.thumb_url | string | |
|
video_id
|
videos.video_id | string | |
|
video_title
|
videos.video_title | string | |
|
video_type
|
videos.video_type | string | |
|
video_url
|
videos.video_url | string |
Télécharger le document
Le fichier de document peut toujours être téléchargé, mais il est probable que vous souhaitez le télécharger lorsqu’il a l’état Signé.
Vous pouvez choisir de recevoir une URL de téléchargement ou d’obtenir le fichier binaire.
L’URL de téléchargement est accessible 10 minutes après la création d’une demande.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Document ID
|
documentId | True | string |
Document ID |
|
Retourner le fichier binaire directement
|
direct | string |
Retourner le fichier binaire directement |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
document_url
|
document_url | string | |
|
file
|
file | string |
Déclencheurs
| Lorsqu’un document a été examiné |
Se déclenche lorsqu’un document a été examiné par l’un des destinataires |
| Lorsqu’un document a été rejeté |
Se déclenche lorsqu’un document a été rejeté par l’un des destinataires |
| Lorsqu’un document a été signé |
Se déclenche lorsqu’un document a été signé par toutes les parties de signature |
| S’abonner aux événements de document |
Cet appel crée un abonnement. La réponse est encapsulée dans un tableau même pour un objet unique en fonction des normes de raccordement REST.
|
Lorsqu’un document a été examiné
Se déclenche lorsqu’un document a été examiné par l’un des destinataires
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Tous les utilisateurs d’entité
|
global | boolean |
Si le webhook doit intercepter les événements pour tous les utilisateurs d’entité. |
|
|
E-mail d’erreur
|
notification_email | string |
Si l’événement échoue, envoyez une notification à cet e-mail au lieu de l’expéditeur |
|
|
Charge utile
|
payload | string |
Données de charge utile supplémentaires à publier |
Retours
Charge utile de webhook
- Webhook
- Webhook
Lorsqu’un document a été rejeté
Se déclenche lorsqu’un document a été rejeté par l’un des destinataires
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Tous les utilisateurs d’entité
|
global | boolean |
Si le webhook doit intercepter les événements pour tous les utilisateurs d’entité. |
|
|
E-mail d’erreur
|
notification_email | string |
Si l’événement échoue, envoyez une notification à cet e-mail au lieu de l’expéditeur |
|
|
Charge utile
|
payload | string |
Données de charge utile supplémentaires à publier |
Retours
Charge utile de webhook
- Webhook
- Webhook
Lorsqu’un document a été signé
Se déclenche lorsqu’un document a été signé par toutes les parties de signature
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Tous les utilisateurs d’entité
|
global | boolean |
Si le webhook doit intercepter les événements pour tous les utilisateurs d’entité. |
|
|
E-mail d’erreur
|
notification_email | string |
Si l’événement échoue, envoyez une notification à cet e-mail au lieu de l’expéditeur |
|
|
Charge utile
|
payload | string |
Données de charge utile supplémentaires à publier |
Retours
Charge utile de webhook
- Webhook
- Webhook
S’abonner aux événements de document
Cet appel crée un abonnement. La réponse est encapsulée dans un tableau même pour un objet unique en fonction des normes de raccordement REST.
Événements
-
document.created- Le document est créé -
document.sent- Le document est envoyé -
document.viewed- Le document est envoyé -
document.signed- Le document est signé -
document.approved- Le document est approuvé -
document.expired- Le document a expiré -
document.rejected- Le document est rejeté -
document.downloaded- Le document est téléchargé -
document.printed- Le document est imprimé -
document.forwarded- Le document est transféré -
document.partially_signed- Le document a été partiellement signé -
document.commented- Le document est commenté -
document.hardbounced- Le document est mis en dur -
document.imported- Le document est importé
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Sélectionner un événement
|
event | True | string |
Déclencheur d’événement |
|
Tous les utilisateurs d’entité
|
global | boolean |
Si le webhook doit intercepter les événements pour tous les utilisateurs d’entité. |
|
|
E-mail d’erreur
|
notification_email | string |
Si l’événement échoue, envoyez une notification à cet e-mail au lieu de l’expéditeur |
|
|
Charge utile
|
payload | string |
Données de charge utile supplémentaires à publier |
Retours
Charge utile de webhook
- Webhook
- Webhook
Définitions
Pièce jointe
Pièce jointe de document
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Destinataires d’accès
|
access_recipient_names | array of string |
Destinataires ayant accès à la pièce jointe |
|
Descriptif
|
attachment_description | string |
Description de la pièce jointe |
|
URL de téléchargement
|
attachment_download_url | string |
URL pour télécharger la pièce jointe |
|
Extension de fichier
|
attachment_extension | string |
Extension de fichier de la pièce jointe |
|
Filename
|
attachment_filename | string |
Nom de fichier de la pièce jointe |
|
ID
|
attachment_id | string |
ID de la pièce jointe |
|
URL d’aperçu
|
attachment_preview_url | string |
URL interne pour afficher un aperçu de la pièce jointe |
|
Titre
|
attachment_title | string |
Titre de la pièce jointe |
|
Type
|
attachment_type | string |
Type de la pièce jointe |
|
URL
|
attachment_url | string |
URL de la pièce jointe |
|
Dernière vue
|
last_attachment_view | string |
Date et heure de la dernière vue de la pièce jointe |
|
Accès restreint
|
restrict_access | boolean |
La pièce jointe a un accès restreint |
Attachments
Liste de pièces jointes
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
attachments
|
attachments | array of Attachment |
Contact
Chaque adresse de messagerie unique (ou numéro mobile) est définie en tant que contact.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID d’entreprise
|
company_id | string |
ID d’entreprise |
|
Logo de l’entreprise
|
company_logo_url | string |
Logo de l’entreprise |
|
Nom de la société
|
company_name | string |
Nom de la société du contact |
|
Numéro d’entreprise
|
company_number | string |
Numéro d’entreprise du contact |
|
Identifiant de contact
|
contact_id | string |
Identifiant de contact |
|
Créé
|
created_at | string |
Date du contact créé |
|
Documents
|
document_count | number |
Nombre de documents pour un contact |
|
E-mail de contact
|
string |
Nom du document créé |
|
|
Prénom
|
first_name | string |
Prénom du contact |
|
Nom complet
|
fullname | string |
Nom complet du contact |
|
Gender
|
gender | string |
Sexe du destinataire |
|
Nom
|
last_name | string |
Nom du contact |
|
Téléphone mobile
|
mobile | string |
Numéro de téléphone mobile du contact |
|
Note
|
note | string |
Remarque du contact |
|
URL du pouce
|
thumb_url | string |
URL du pouce du contact |
|
Titre
|
title | string |
Titre du contact |
Contacts
Liste de contacts
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
contacts
|
contacts | array of Contact |
Document
Un document est un ou plusieurs fichiers chargés qui doivent être envoyés à un ou plusieurs destinataires créés par un utilisateur.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Étiquettes
|
tags | string |
Balises de document |
|
Texte de conversation automatique
|
auto_comment_text | string |
Texte de conversation automatique |
|
Nom de l’entreprise
|
company_name | string |
Nom de l’entreprise |
|
Créé à
|
created_at | string |
Lorsque le document a été créé |
|
URL de téléchargement
|
download_url | string |
URL pour télécharger le document signé |
|
Message électronique
|
email_send_message | string |
Envoi d’un message électronique |
|
Objet de l’e-mail
|
email_send_subject | string |
Texte de l’objet de l’e-mail |
|
Date d'expiration
|
expiration_date | string |
Date d’expiration du document |
|
ID client externe
|
external_client_id | string | |
|
ID de l’éditeur externe
|
external_editor_id | string |
ID dans l’éditeur externe |
|
Type d’éditeur externe
|
external_editor_type | string | |
|
External ID
|
external_id | string | |
|
Nombre de champs
|
field_count | integer |
Nombre de champs dans le document |
|
ID
|
id | string | |
|
Commentaire automatique
|
is_auto_comment | boolean |
Si le commentaire de conversation automatique est activé |
|
E-mail de commentaire automatique
|
is_auto_comment_email | boolean |
Si l’e-mail de conversation automatique est activé |
|
Identifier le destinataire
|
is_identify_recipient | boolean |
Si le document a identifié le destinataire activé |
|
Est privé
|
is_private | boolean |
Si le document est privé |
|
Envoyer des rappels
|
is_reminder_sending | boolean |
Si les rappels automatiques sont activés |
|
Envoi planifié
|
is_scheduled_sending | boolean |
Si le document a planifié l’envoi |
|
Auto-signature
|
is_selfsign | boolean |
Si le document a été auto-signé par l’expéditeur |
|
Est signé
|
is_signed | boolean |
Si le document a été signé |
|
Document signable
|
is_signing | boolean |
Si le document est signable |
|
Signature manuscrite
|
is_signing_biometric | boolean |
Si la signature manuscrite est activée |
|
Autoriser le transfert de signature
|
is_signing_forward | boolean |
Si le transfert des droits de signature est activé |
|
Ordre de signature
|
is_signing_order | boolean |
Si l’ordre de signature du destinataire est activé |
|
Has Video
|
is_video | boolean |
Si le document a une vidéo d’introduction |
|
Nom
|
name | string |
Nom du document |
|
Parent ID
|
parent_id | string |
ID de la version précédente du document |
|
URL d’aperçu
|
preview_url | string |
Lien vers l’aperçu interne du document |
|
destinataires
|
recipients | array of Recipient | |
|
Heure d’envoi planifiée
|
scheduled_sending_time | string |
Lorsque le document a été planifié pour l’envoi |
|
Date d’envoi
|
send_date | string |
Date d’envoi du document |
|
E-mail de l’expéditeur
|
sender_email | string |
Adresse e-mail de l’utilisateur expéditeur |
|
Nom de l’expéditeur
|
sender_name | string |
Nom de l’utilisateur expéditeur |
|
URL du pouce de l’expéditeur
|
sender_thumb_url | string |
Image pouce de l’utilisateur expéditeur |
|
Date de signature
|
sign_date | string |
Date de signature du document |
|
Statut
|
status | string |
État actuel du document |
|
URL du pouce
|
thumb_url | string |
Image numérique du document |
|
Type
|
type | string |
Type de document |
|
ID unique
|
unique_id | integer |
ID unique pour le document |
|
ID d’utilisateur
|
user_id | string |
ID de l’utilisateur expéditeur |
|
Valeur
|
value | integer |
Valeur du document |
Documents
Liste des documents
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
tags
|
tags | string | |
|
company_name
|
company_name | string | |
|
date_de_création
|
created_at | string | |
|
expiration_date
|
expiration_date | string | |
|
pièce d'identité
|
id | string | |
|
is_private
|
is_private | boolean | |
|
is_signing
|
is_signing | boolean | |
|
nom
|
name | string | |
|
sender_name
|
sender_name | string | |
|
sender_thumb
|
sender_thumb | string | |
|
status
|
status | string | |
|
type
|
type | string | |
|
value
|
value | integer |
EditorField
Détails du champ de l’éditeur
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
ID |
|
Étiquette
|
input_settings.label | string |
Étiquette |
|
Options
|
input_settings.options | array of string |
Options |
|
Obligatoire
|
input_settings.required | boolean |
Obligatoire |
|
Type
|
input_settings.type | string |
Type |
|
ID du destinataire
|
recipient_id | string |
ID du destinataire |
|
Type
|
type | string |
Type |
|
ID d’utilisateur
|
user_id | string |
ID d’utilisateur |
Terrain
Détails du champ
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nom de l’entreprise
|
company_name | string |
Nom de l’entreprise |
|
Numéro d’entreprise
|
company_number | string |
Numéro d’entreprise |
|
ID de champ
|
field_id | string |
ID de champ |
|
Étiquette
|
field_label | string |
Étiquette |
|
Options
|
field_options | array of object |
Options |
|
Valeur
|
field_options.value | string | |
|
Type
|
field_type | string |
Type |
|
Valeur
|
field_value | string |
Valeur |
|
is_collectable
|
is_collectable | boolean |
Champ de collecte |
|
is_editable
|
is_editable | boolean |
Champ modifiable |
|
is_required
|
is_required | boolean |
Champ obligatoire |
|
Page ID
|
page_id | string |
Page ID |
|
ID du destinataire
|
recipient_id | string |
ID du destinataire |
|
Nom du destinataire
|
recipient_name | string |
Nom du destinataire |
|
Nom du rôle
|
role_name | string |
Nom du rôle |
Fields
Liste des champs
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
editor_fields
|
editor_fields | array of EditorField | |
|
fields
|
fields | array of Field |
PricingColumn
Colonne table de tarification
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
column_id | string |
ID |
|
Nom d’affichage
|
display_name | string |
Nom d’affichage |
|
Enabled
|
enabled | boolean |
Enabled |
|
Nom
|
name | string |
Nom |
PricingSection
Section Table de tarification
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
columns
|
columns | array of PricingColumn | |
|
Nom d’affichage
|
display_name | string |
Nom d’affichage |
|
Nom
|
name | string |
Nom |
|
ID
|
section_id | string |
ID |
PricingTable
Tableau tarifaire
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Monnaie
|
currency_settings.currency | string |
Monnaie |
|
Paramètres régionaux
|
currency_settings.locale | string |
Paramètres régionaux |
|
Totaux précalculés
|
pre_calculated | boolean |
Totaux précalculés |
|
Sections
|
sections | array of PricingSection | |
|
ID
|
table_id | string |
Table ID |
PricingTables
Tables de tarification
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
pricing_tables
|
pricing_tables | array of PricingTable |
Recipient
Chaque adresse de messagerie unique (ou numéro mobile) connectée à un document est un destinataire.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nom de la société
|
company_name | string |
Nom de la société du destinataire |
|
Numéro d’entreprise
|
company_number | string |
Numéro d’entreprise du destinataire |
|
Document URL
|
document_url | string |
URL unique pour le destinataire à afficher/signer |
|
E-mail du destinataire
|
string |
E-mail du destinataire |
|
|
Prénom
|
first_name | string |
Prénom du destinataire |
|
Nom complet
|
fullname | string |
Nom complet du destinataire |
|
Gender
|
gender | string |
Sexe du destinataire |
|
ID
|
id | string |
ID du destinataire |
|
Nom
|
last_name | string |
Nom du destinataire |
|
Téléphone mobile
|
mobile | string |
Numéro mobile du destinataire |
|
Note
|
note | string |
Remarque du destinataire |
|
Numéro de commande de signature
|
order_num | string |
Ordre de signature du destinataire |
|
Statut
|
status | string |
État du destinataire |
|
URL du pouce
|
thumb_url | string |
URL du pouce du destinataire |
|
Titre
|
title | string |
Titre du destinataire |
Destinataires
Liste des destinataires
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
destinataires
|
recipients | array of Recipient |
Utilisateur
Un utilisateur est défini par son adresse de messagerie et est connecté à une ou plusieurs entités.
Rôles d'utilisateur
Administrateur :
- Afficher tous les documents
- Modifier tous les documents
- Modifier les paramètres d’entité, les informations et la facturation
- Ajouter de nouveaux utilisateurs à l’entité
- Attribuer des rôles d’entité
Gérant:
- Afficher les documents d’équipe
- Modifier tous les documents
- Ajouter de nouveaux utilisateurs à l’entité
Entité
Une entité est le nœud supérieur et tous les utilisateurs et documents correspondants sont connectés à une entité. Une entité est souvent la même qu’une entreprise, un pays ou un service dans une grande organisation.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Mode d’application
|
app_mode | string | |
|
disallow_create
|
disallow_create | boolean | |
|
Messagerie électronique
|
string |
Adresse e-mail de l’utilisateur |
|
|
ID d’entité
|
entity_id | string | |
|
Nom de l’entité
|
entity_name | string | |
|
Prénom
|
first_name | string |
Prénom de l’utilisateur |
|
ID
|
id | string |
ID de l’utilisateur |
|
Language
|
language | string | |
|
Nom
|
last_name | string |
Nom de l’utilisateur |
|
mobile
|
mobile | string |
Numéro de téléphone mobile au format international |
|
Note
|
note | string |
Note interne facultative pour l’utilisateur |
|
Téléphone
|
phone | string |
Numéro de téléphone au format international |
|
Role
|
role | string | |
|
Ignorer l’envoi d’invitations
|
skip_invitation | boolean | |
|
Statut
|
status | string | |
|
ID d’équipe
|
team_id | string | |
|
URL du pouce
|
thumb_url | string | |
|
Timezone
|
timezone | string | |
|
Titre
|
title | string |
Titre de l’utilisateur, par exemple. Pdg, Directeur commercial |
Users
Liste des utilisateurs
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
users
|
users | array of object | |
|
Messagerie électronique
|
users.email | string | |
|
Prénom
|
users.first_name | string | |
|
Dernière connexion
|
users.last_login | string | |
|
Nom de famille
|
users.last_name | string | |
|
Nom d'utilisateur
|
users.name | string | |
|
Role
|
users.role | string | |
|
Statut
|
users.status | string | |
|
Nom de l’équipe
|
users.team_name | string | |
|
ID d’utilisateur
|
users.user_id | string |
Webhook
Charge utile de webhook
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Champs personnalisés
|
custom_fields | object | |
|
Document
|
document | Document |
Un document est un ou plusieurs fichiers chargés qui doivent être envoyés à un ou plusieurs destinataires créés par un utilisateur. |
|
Domaine personnalisé d’entité
|
entity.custom_domain | string |
Paramètre de domaine personnalisé pour l’entité |
|
Message électronique par défaut
|
entity.email_send_message | string |
Message électronique par défaut |
|
Objet de messagerie par défaut
|
entity.email_send_subject | string |
Objet de messagerie par défaut |
|
Sous-domaine d’entité
|
entity.sub_domain | string |
Sous-domaine de l’entité |
|
Nom de l’événement
|
event | string | |
|
Action d’événement
|
event_action | string | |
|
Type d'événement
|
event_type | string | |
|
Recipient
|
recipient | Recipient |
Chaque adresse de messagerie unique (ou numéro mobile) connectée à un document est un destinataire. |
|
Identifiant d’abonnement
|
subscription_id | string |