BlueInk
Le connecteur Blueink vous permet d’ajouter la plateforme eSignature de Blueink aux flux de travail automatisés. Le connecteur vous permet de vérifier l’état de l’offre groupée, de créer des offres groupées, d’accéder aux informations du signataire, etc.
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 | Prise en charge de Blueink |
| URL | https://help.blueink.com/en/ |
| Messagerie électronique | support@blueink.com |
| Métadonnées du connecteur | |
|---|---|
| Éditeur | Blueink |
| Site internet | https://blueink.com |
| Politique de confidentialité | https://blueink.com/privacy-policy/ |
| Catégories | Gestion de l’entreprise ; Productivité |
Avec ce connecteur polyvalent, les utilisateurs peuvent intégrer en toute transparence la solution eSignature puissante de Blueink dans leur flux de travail en tirant parti des fonctionnalités de différents connecteurs Power Automate. Cette intégration permet aux utilisateurs d’automatiser la création et la distribution d’ensembles de documents sans effort. En orchestrant l’interaction harmonieuse de ce connecteur avec d’autres connecteurs, vous pouvez simplifier vos processus de gestion des documents, améliorer l’efficacité et garantir une expérience de signature de documents transparente et efficace pour vos clients et parties prenantes. Qu’il s’agisse d’automatiser les approbations de contrat, de traiter des documents juridiques ou de gérer la paperasserie dans tout autre contexte, ce connecteur fournit un outil puissant pour optimiser votre flux de travail et améliorer la productivité.
Prerequisites
Pour utiliser ce connecteur, vous aurez besoin d’un compte activé par l’API à partir de blueink.com.
Comment obtenir des informations d’identification
Après avoir créé votre compte, cliquez sur le bouton API situé à gauche de la page. Sous Clés API privées, appuyez sur le bouton Ajouter une clé API . Donnez à la clé API une étiquette et appuyez sur Envoyer. Copiez la clé API et enregistrez-la quelque part, car elle ne sera plus affichée.
Bien démarrer avec votre connecteur
Lors de la création d’une connexion Blueink, vous êtes invité à entrer une clé API. Votre clé API doit toujours commencer par le jeton suivi d’un espace, puis de la clé API que vous avez créée. La saisie de votre clé API doit ressembler à cette clé< d’API de jeton>.
Une action populaire consiste à créer un bundle. La création d’un bundle nécessite un ensemble complexe d’entrées. Consultez notre documentation sur l’API pour https://blueink.com/esignature-api/api-docs/#tag/Bundles/operation/createBundle connaître l’apparence de la variable de corps. Image ci-dessous sous la forme d’un exemple de corps de création de bundle.
Il existe plusieurs façons de créer un bundle et vous pouvez modifier ce code JSON en fonction du bundle que vous souhaitez créer. Examinez l’API pour plus d’informations sur la modification de ce CODE JSON. Celui-ci utilise un modèle créé précédemment que l’utilisateur a configuré dans son compte.
La liste de tous les bundles terminés est un autre point de terminaison populaire. Ajoutez l’action List Bundles, puis remplacez le bouton d’état par co pour les offres groupées terminées. Vous pouvez tenir à jour avec toutes vos dernières offres groupées terminées à l’aide de ce point de terminaison.
Problèmes connus et limitations
Un json de corps est requis pour le point de terminaison de création de bundle
Erreurs courantes et solutions
Si vous recevez une erreur concernant une requête qui ne réussit pas avec une erreur de jeton non valide, assurez-vous que vous n’avez pas simplement collé la clé API et que la chaîne de jeton précédente a été suivie d’un espace, puis de votre clé API.
Si vous recevez une erreur concernant une entrée non valide lors de la création d’un bundle, vérifiez qu’il s’agit d’un JSON valide qui est envoyé à Blueink.
Questions fréquentes (FAQ)
1. Qu’est-ce que Blueink ?
- Blueink est une solution eSignature avancée qui simplifie le processus de signature de document, ce qui facilite l’envoi, la signature et la gestion sécurisée des documents électroniques.
2. Qu’est-ce que le connecteur Microsoft pour Blueink ?
- Le connecteur Microsoft pour Blueink est un outil qui permet aux utilisateurs d’intégrer la solution eSignature de Blueink en toute transparence à Microsoft Power Automate, ce qui permet l’automatisation et la gestion améliorée des documents.
3. Comment fonctionne le connecteur Microsoft pour Blueink ?
- Le connecteur vous permet de créer des flux de travail automatisés en combinant Blueink avec d’autres connecteurs Power Automate. Vous pouvez automatiser la création et la distribution d’offres groupées de documents, ce qui améliore vos processus de gestion des documents.
4. Quels sont les cas d’usage du connecteur Microsoft pour Blueink ?
- Les cas d’usage courants incluent l’automatisation des approbations de contrat, la gestion des documents juridiques, la rationalisation des processus de paperasse et la garantie d’une expérience de signature de documents fluide et efficace pour les clients et les parties prenantes.
5. Puis-je utiliser le connecteur Microsoft pour Blueink avec d’autres produits Microsoft ?
- Oui, le connecteur est conçu pour fonctionner en toute transparence avec différents produits et services Microsoft, ce qui vous permet d’intégrer Blueink eSignatures dans vos flux de travail centrés sur Microsoft.
6. Le connecteur Microsoft pour Blueink est-il facile à configurer et à utiliser ?
- Oui, il est convivial et conçu pour être simple. Vous pouvez configurer et personnaliser vos flux de travail en fonction de vos besoins spécifiques en matière de gestion des documents.
7. Existe-t-il un coût associé à l’utilisation du connecteur Microsoft pour Blueink ?
- La tarification peut varier en fonction de vos contrats d’utilisation et de licence. Il est préférable de consulter Blueink ou Microsoft pour obtenir des détails de tarification spécifiques.
8. Puis-je obtenir du support technique pour les problèmes techniques liés au connecteur Microsoft pour Blueink ?
- Oui, Blueink et Microsoft offrent généralement des ressources de support et de la documentation pour vous aider à résoudre les problèmes techniques ou questions que vous pouvez avoir concernant l’utilisation du connecteur.
9. Le connecteur Microsoft pour Blueink est-il compatible avec les services Microsoft Windows et cloud ?
- Oui, le connecteur est conçu pour fonctionner avec les services Microsoft locaux et cloud, ce qui offre une flexibilité dans vos options d’intégration.
10. Où puis-je trouver plus d’informations sur le connecteur Microsoft pour Blueink ?
- Pour plus d’informations, notamment des guides de configuration et de la documentation, vous pouvez visiter le site web Blueink ou explorer la documentation Microsoft Power Automate relative à ce connecteur.
Création d’une connexion
Le connecteur prend en charge les types d’authentification suivants :
| Par défaut | Paramètres de création de connexion. | Toutes les régions | Non partageable |
Faire défaut
Applicable : Toutes les régions
Paramètres de création de connexion.
Cette connexion n’est pas partageable. Si l’application power est partagée avec un autre utilisateur, un autre utilisateur est invité à créer une connexion explicitement.
| Nom | Type | Descriptif | Obligatoire |
|---|---|---|---|
| Clé API Blueink | securestring | Votre clé API Blueink. Cette opération peut être créée dans Blueink sous l’onglet API. Le format correct est « Token XXXXXX » où XXXXXX est votre clé API | Vrai |
Limitations
| Nom | Appels | Période de renouvellement |
|---|---|---|
| Appels d’API par connexion | 100 | 60 secondes |
Actions
| Ajouter des étiquettes à un bundle |
Ajoutez des balises supplémentaires à un bundle. Aucune balise existante sur le bundle n’est supprimée. Le résultat de cet appel est que Bundle.tags est l’union de l’ensemble de balises précédentes avec l’ensemble de nouvelles balises. Les balises en double sont ignorées. |
| Annuler un bundle |
Annuler l’offre groupée spécifiée par le slug groupé |
| Créer un bundle |
Créer et envoyer un bundle pour la signature |
| Créer un webhook |
Créer un webhook |
|
Créer un Webhook |
Créer un en-tête webhook |
| Créer une personne |
Créez une personne. Une personne peut être associée à un utilisateur BlueInk ou être une personne autonome. Si vous souhaitez créer une personne associée à un utilisateur BlueInk, vous devez fournir le |
| Créer une URL de signature incorporée |
Créer une URL qui peut être utilisée pour la signature incorporée |
| Envoyer un rappel |
Envoyez un e-mail de rappel ou un SMS à un signataire. Un rappel ne peut être envoyé qu’une fois par heure. Le rappel sera envoyé via la méthode de remise (e-mail ou SMS) et à l’adresse e-mail (ou numéro de téléphone) précédemment désigné pour ce paquet. |
| Liste des personnes |
Obtenez la liste des personnes dans votre compte. Vous pouvez éventuellement filtrer la liste en fournissant une requête de recherche. Par exemple, pour rechercher toutes les personnes portant le nom « John », vous devez utiliser la requête |
| Mettre à jour partiellement un Webhook |
Mettez partiellement à jour le Webhook avec de nouvelles données. |
|
Mettre à jour partiellement un Webhook |
Mettez partiellement à jour le WebhookExtraHeader avec de nouvelles données. |
| Mettre à jour partiellement une personne |
Mettez partiellement à jour la personne avec de nouvelles données. Pour ajouter un nouvel e-mail ou un téléphone à la personne, incluez un ContactChannel dans le tableau « canaux » sans « ID ». Pour mettre à jour un ContactChannel existant associé à la personne, incluez un « ID ». Ce contactChannel existant sera mis à jour avec le nouvel e-mail ou le nouveau téléphone. Cela met à jour tous les bundles en direct associés à la personne qui envoie à cet e-mail (ou téléphone). Si un ContactChannel n’inclut pas d’id, mais que l’e-mail (ou téléphone) correspond à un ContactChannel existant, ce ContactChannel ne sera pas modifié. |
| Mettre à jour un paquet |
Mettre à jour un paquet (également appelé signataire) avec un nouvel e-mail, un numéro de téléphone, un nom ou des options d’authentification Le paquet mis à jour doit toujours être livrable. Par exemple, si vous spécifiez une Vous pouvez modifier un paquet qui a été initialement configuré pour la signature incorporée (autrement dit, deliver_via a été « incorporé ») à remettre par e-mail ou SMS. Toutefois, aucune notification ou rappel de signature n’est envoyé automatiquement. Vous devez appeler /packet/{packetId}/rappel/ pour envoyer un e-mail de notification de signature (ou SMS). Si ce signataire est associé à une personne, la personne sera également mise à jour : le nom de la personne sera modifié (s’il est fourni) et tout nouvel e-mail ou numéro de téléphone sera ajouté. |
| Mettre à jour un webhook |
Mettez à jour le Webhook avec de nouvelles données. Notez que tous les abonnements omis de cette demande seront SUPPRIMÉs. Si vous ne souhaitez pas remplacer toutes les données sur le Webhook, vous souhaitez probablement utiliser PATCH à la place. |
|
Mettre à jour un Webhook |
Mettre à jour le WebhookExtraHeader avec de nouvelles données |
| Mettre à jour une personne |
Mettez à jour la personne avec de nouvelles données. Notez que tous les canaux de contact omis de cette demande seront SUPPRIMÉs. Si vous ne souhaitez pas remplacer toutes les données sur la personne, vous souhaitez probablement utiliser PATCH à la place. |
| Obtenir un secret partagé webhook |
Obtenir le secret partagé webhook |
| Récupérer des données groupées |
Obtenir des données entrées dans des champs pour un bundle terminé |
| Récupérer des fichiers groupés |
Obtenir des fichiers téléchargeables pour un bundle terminé |
| Récupérer le certificat de preuve de paquet |
Obtenir un lien et une somme de contrôle du certificat de preuve pour ce paquet |
| Récupérer un bundle |
Récupérer un bundle par slug |
| Récupérer un modèle de document |
Récupérer un modèle de document |
| Récupérer un Webhook |
Obtenir un Webhook par ID |
|
Récupérer un Webhook |
Récupérer les détails d’un WebhookExtraHeader |
| Récupérer une personne |
Obtenir une personne par ID |
| Régénérer le secret partagé webhook |
Régénérer le secret partagé webhook |
| Répertorier les bundles |
Retourne une liste paginé d’offres groupées dans votre compte, triée par date de création (de la plus récente à la plus récente). La pagination peut être contrôlée via des paramaters pagination (voir Overview-Pagination>).
Les filtres querystring peuvent être combinés, par exemple |
| Répertorier les modèles de documents |
Répertorier tous les modèles de document |
| Répertorier les webhooks |
Répertorier tous les webhooks dans votre compte BlueInk |
| Répertorier les événements groupés |
Obtenir la liste des événements associés à l’offre groupée |
|
Répertorier webhook |
Répertorier tous les événements Webhook dans votre compte BlueInk |
|
Répertorier webhook |
Répertorier tous les WebhookDeliveries dans votre compte BlueInk |
|
Répertorier Webhook |
Répertorier tous les WebhookExtraHeaders dans votre compte BlueInk |
| Supprimer des balises d’un bundle |
Supprimez les balises d’un bundle. Si une balise dans la demande n’existe pas sur le bundle, elle est ignorée. |
| Supprimer un webhook |
Supprimer un Webhook par ID |
|
Supprimer un Webhook |
Supprimer un WebhookExtraHeader |
| Supprimer une personne |
Supprimez une personne. Cela supprime également tout utilisateur BlueInk associé. |
Ajouter des étiquettes à un bundle
Ajoutez des balises supplémentaires à un bundle. Aucune balise existante sur le bundle n’est supprimée. Le résultat de cet appel est que Bundle.tags est l’union de l’ensemble de balises précédentes avec l’ensemble de nouvelles balises. Les balises en double sont ignorées.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Bundle Slug
|
bundleSlug | True | string |
Le slug qui identifie de façon unique le bundle |
|
tags
|
tags | array of string |
Tableau de balises |
Annuler un bundle
Annuler l’offre groupée spécifiée par le slug groupé
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Bundle Slug
|
bundleSlug | True | string |
Le slug qui identifie de façon unique le bundle |
Créer un bundle
Créer et envoyer un bundle pour la signature
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
body
|
body |
Corps JSON qui définit le bundle à créer |
Créer un webhook
Créer un webhook
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
enabled
|
enabled | boolean | ||
|
event_types
|
event_types | array of string |
types d’événements qui déclenchent le webhook |
|
|
pièce d'identité
|
id | uuid | ||
|
nom
|
name | string |
doit adhérer à RFC 7230 |
|
|
order
|
order | integer | ||
|
value
|
value | string |
doit adhérer à RFC 7230 |
|
|
point d'ancrage web (webhook)
|
webhook | uuid | ||
|
pièce d'identité
|
id | uuid | ||
|
json
|
json | boolean | ||
|
URL
|
url | url |
doit être l’URL complète, y compris http/https |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
enabled
|
enabled | boolean | |
|
event_types
|
event_types | array of string |
types d’événements qui déclenchent le webhook |
|
extra_headers
|
extra_headers | array of object | |
|
pièce d'identité
|
extra_headers.id | uuid | |
|
nom
|
extra_headers.name | string |
doit adhérer à RFC 7230 |
|
order
|
extra_headers.order | integer | |
|
value
|
extra_headers.value | string |
doit adhérer à RFC 7230 |
|
point d'ancrage web (webhook)
|
extra_headers.webhook | uuid | |
|
pièce d'identité
|
id | uuid | |
|
json
|
json | boolean | |
|
URL
|
url | url |
doit être l’URL complète, y compris http/https |
Créer un WebhookExtraHeader
Créer un en-tête webhook
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
pièce d'identité
|
id | uuid | ||
|
nom
|
name | string |
doit adhérer à RFC 7230 |
|
|
order
|
order | integer | ||
|
value
|
value | string |
doit adhérer à RFC 7230 |
|
|
point d'ancrage web (webhook)
|
webhook | uuid |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
pièce d'identité
|
id | uuid | |
|
nom
|
name | string |
doit adhérer à RFC 7230 |
|
order
|
order | integer | |
|
value
|
value | string |
doit adhérer à RFC 7230 |
|
point d'ancrage web (webhook)
|
webhook | uuid |
Créer une personne
Créez une personne. Une personne peut être associée à un utilisateur BlueInk ou être une personne autonome. Si vous souhaitez créer une personne associée à un utilisateur BlueInk, vous devez fournir le user_id champ. Si vous souhaitez créer une personne autonome, vous devez fournir le name champ.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Messagerie électronique
|
||||
|
pièce d'identité
|
id | uuid | ||
|
gentil
|
kind | string |
em pour l’e-mail. mp pour téléphone. |
|
|
phone
|
phone | phone | ||
|
pièce d'identité
|
id | uuid | ||
|
is_user
|
is_user | boolean |
True si cette personne est associée à un utilisateur BlueInk |
|
|
metadata
|
metadata | object |
Métadonnées à associer à cette personne. Les métadonnées peuvent être utilisées dans SmartFill pour remplir automatiquement des documents. Pour plus d’informations, consultez la documentation SmartFill. |
|
|
nom
|
name | string |
Nom de la personne |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
channels
|
channels | array of object | |
|
Messagerie électronique
|
channels.email | ||
|
pièce d'identité
|
channels.id | uuid | |
|
gentil
|
channels.kind | string |
em pour l’e-mail. mp pour téléphone. |
|
phone
|
channels.phone | phone | |
|
pièce d'identité
|
id | uuid | |
|
is_user
|
is_user | boolean |
True si cette personne est associée à un utilisateur BlueInk |
|
metadata
|
metadata | object |
Métadonnées à associer à cette personne. Les métadonnées peuvent être utilisées dans SmartFill pour remplir automatiquement des documents. Pour plus d’informations, consultez la documentation SmartFill. |
|
nom
|
name | string |
Nom de la personne |
Créer une URL de signature incorporée
Créer une URL qui peut être utilisée pour la signature incorporée
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Slug de paquet
|
packetId | True | string |
Le slug qui identifie de façon unique le paquet |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Expire
|
expires | date-time |
Horodatage indiquant quand l’URL expire |
|
URL
|
url | string |
URL qui peut être utilisée pour la signature incorporée |
Envoyer un rappel
Envoyez un e-mail de rappel ou un SMS à un signataire. Un rappel ne peut être envoyé qu’une fois par heure. Le rappel sera envoyé via la méthode de remise (e-mail ou SMS) et à l’adresse e-mail (ou numéro de téléphone) précédemment désigné pour ce paquet.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Slug de paquet
|
packetId | True | string |
Le slug qui identifie de façon unique le paquet |
Liste des personnes
Obtenez la liste des personnes dans votre compte. Vous pouvez éventuellement filtrer la liste en fournissant une requête de recherche. Par exemple, pour rechercher toutes les personnes portant le nom « John », vous devez utiliser la requête search=John.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Requête de recherche
|
search | string |
Requête de recherche. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
channels
|
channels | array of object | |
|
Messagerie électronique
|
channels.email | ||
|
pièce d'identité
|
channels.id | uuid | |
|
gentil
|
channels.kind | string |
em pour l’e-mail. mp pour téléphone. |
|
phone
|
channels.phone | phone | |
|
pièce d'identité
|
id | uuid | |
|
is_user
|
is_user | boolean |
True si cette personne est associée à un utilisateur BlueInk |
|
metadata
|
metadata | object |
Métadonnées à associer à cette personne. Les métadonnées peuvent être utilisées dans SmartFill pour remplir automatiquement des documents. Pour plus d’informations, consultez la documentation SmartFill. |
|
nom
|
name | string |
Nom de la personne |
Mettre à jour partiellement un Webhook
Mettez partiellement à jour le Webhook avec de nouvelles données.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Webhook ID
|
webhookId | True | uuid |
ID qui identifie de manière unique le Webhook |
|
enabled
|
enabled | boolean | ||
|
event_types
|
event_types | array of string |
types d’événements qui déclenchent le webhook |
|
|
pièce d'identité
|
id | uuid | ||
|
nom
|
name | string |
doit adhérer à RFC 7230 |
|
|
order
|
order | integer | ||
|
value
|
value | string |
doit adhérer à RFC 7230 |
|
|
point d'ancrage web (webhook)
|
webhook | uuid | ||
|
pièce d'identité
|
id | uuid | ||
|
json
|
json | boolean | ||
|
URL
|
url | url |
doit être l’URL complète, y compris http/https |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
enabled
|
enabled | boolean | |
|
event_types
|
event_types | array of string |
types d’événements qui déclenchent le webhook |
|
extra_headers
|
extra_headers | array of object | |
|
pièce d'identité
|
extra_headers.id | uuid | |
|
nom
|
extra_headers.name | string |
doit adhérer à RFC 7230 |
|
order
|
extra_headers.order | integer | |
|
value
|
extra_headers.value | string |
doit adhérer à RFC 7230 |
|
point d'ancrage web (webhook)
|
extra_headers.webhook | uuid | |
|
pièce d'identité
|
id | uuid | |
|
json
|
json | boolean | |
|
URL
|
url | url |
doit être l’URL complète, y compris http/https |
Mettre à jour partiellement un WebhookExtraHeader
Mettez partiellement à jour le WebhookExtraHeader avec de nouvelles données.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
WebhookExtraHeader ID
|
webhookExtraHeaderId | True | uuid |
ID qui identifie de façon unique le WebhookExtraHeader |
|
pièce d'identité
|
id | uuid | ||
|
nom
|
name | string |
doit adhérer à RFC 7230 |
|
|
order
|
order | integer | ||
|
value
|
value | string |
doit adhérer à RFC 7230 |
|
|
point d'ancrage web (webhook)
|
webhook | uuid |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
pièce d'identité
|
id | uuid | |
|
nom
|
name | string |
doit adhérer à RFC 7230 |
|
order
|
order | integer | |
|
value
|
value | string |
doit adhérer à RFC 7230 |
|
point d'ancrage web (webhook)
|
webhook | uuid |
Mettre à jour partiellement une personne
Mettez partiellement à jour la personne avec de nouvelles données.
Pour ajouter un nouvel e-mail ou un téléphone à la personne, incluez un ContactChannel dans le tableau « canaux » sans « ID ».
Pour mettre à jour un ContactChannel existant associé à la personne, incluez un « ID ». Ce contactChannel existant sera mis à jour avec le nouvel e-mail ou le nouveau téléphone. Cela met à jour tous les bundles en direct associés à la personne qui envoie à cet e-mail (ou téléphone).
Si un ContactChannel n’inclut pas d’id, mais que l’e-mail (ou téléphone) correspond à un ContactChannel existant, ce ContactChannel ne sera pas modifié.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de personne
|
personId | True | uuid |
ID qui identifie de façon unique la personne |
|
Messagerie électronique
|
||||
|
pièce d'identité
|
id | uuid | ||
|
gentil
|
kind | string |
em pour l’e-mail. mp pour téléphone. |
|
|
phone
|
phone | phone | ||
|
pièce d'identité
|
id | uuid | ||
|
is_user
|
is_user | boolean |
True si cette personne est associée à un utilisateur BlueInk |
|
|
metadata
|
metadata | object |
Métadonnées à associer à cette personne. Les métadonnées peuvent être utilisées dans SmartFill pour remplir automatiquement des documents. Pour plus d’informations, consultez la documentation SmartFill. |
|
|
nom
|
name | string |
Nom de la personne |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
channels
|
channels | array of object | |
|
Messagerie électronique
|
channels.email | ||
|
pièce d'identité
|
channels.id | uuid | |
|
gentil
|
channels.kind | string |
em pour l’e-mail. mp pour téléphone. |
|
phone
|
channels.phone | phone | |
|
pièce d'identité
|
id | uuid | |
|
is_user
|
is_user | boolean |
True si cette personne est associée à un utilisateur BlueInk |
|
metadata
|
metadata | object |
Métadonnées à associer à cette personne. Les métadonnées peuvent être utilisées dans SmartFill pour remplir automatiquement des documents. Pour plus d’informations, consultez la documentation SmartFill. |
|
nom
|
name | string |
Nom de la personne |
Mettre à jour un paquet
Mettre à jour un paquet (également appelé signataire) avec un nouvel e-mail, un numéro de téléphone, un nom ou des options d’authentification
Le paquet mis à jour doit toujours être livrable. Par exemple, si vous spécifiez une deliver_via valeur de « téléphone », mais qu’aucun numéro de téléphone n’a été défini dans la requête PacketRequest d’origine, cette demande doit également inclure une phone erreur, ou une erreur est retournée.
Vous pouvez modifier un paquet qui a été initialement configuré pour la signature incorporée (autrement dit, deliver_via a été « incorporé ») à remettre par e-mail ou SMS. Toutefois, aucune notification ou rappel de signature n’est envoyé automatiquement. Vous devez appeler /packet/{packetId}/rappel/ pour envoyer un e-mail de notification de signature (ou SMS).
Si ce signataire est associé à une personne, la personne sera également mise à jour : le nom de la personne sera modifié (s’il est fourni) et tout nouvel e-mail ou numéro de téléphone sera ajouté.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Slug de paquet
|
packetId | True | string |
Le slug qui identifie de façon unique le paquet |
|
body
|
body |
Mettre à jour un webhook
Mettez à jour le Webhook avec de nouvelles données. Notez que tous les abonnements omis de cette demande seront SUPPRIMÉs. Si vous ne souhaitez pas remplacer toutes les données sur le Webhook, vous souhaitez probablement utiliser PATCH à la place.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Webhook ID
|
webhookId | True | uuid |
ID qui identifie de manière unique le Webhook |
|
enabled
|
enabled | boolean | ||
|
event_types
|
event_types | array of string |
types d’événements qui déclenchent le webhook |
|
|
pièce d'identité
|
id | uuid | ||
|
nom
|
name | string |
doit adhérer à RFC 7230 |
|
|
order
|
order | integer | ||
|
value
|
value | string |
doit adhérer à RFC 7230 |
|
|
point d'ancrage web (webhook)
|
webhook | uuid | ||
|
pièce d'identité
|
id | uuid | ||
|
json
|
json | boolean | ||
|
URL
|
url | url |
doit être l’URL complète, y compris http/https |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
enabled
|
enabled | boolean | |
|
event_types
|
event_types | array of string |
types d’événements qui déclenchent le webhook |
|
extra_headers
|
extra_headers | array of object | |
|
pièce d'identité
|
extra_headers.id | uuid | |
|
nom
|
extra_headers.name | string |
doit adhérer à RFC 7230 |
|
order
|
extra_headers.order | integer | |
|
value
|
extra_headers.value | string |
doit adhérer à RFC 7230 |
|
point d'ancrage web (webhook)
|
extra_headers.webhook | uuid | |
|
pièce d'identité
|
id | uuid | |
|
json
|
json | boolean | |
|
URL
|
url | url |
doit être l’URL complète, y compris http/https |
Mettre à jour un WebhookExtraHeader
Mettre à jour le WebhookExtraHeader avec de nouvelles données
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
WebhookExtraHeader ID
|
webhookExtraHeaderId | True | uuid |
ID qui identifie de façon unique le WebhookExtraHeader |
|
pièce d'identité
|
id | uuid | ||
|
nom
|
name | string |
doit adhérer à RFC 7230 |
|
|
order
|
order | integer | ||
|
value
|
value | string |
doit adhérer à RFC 7230 |
|
|
point d'ancrage web (webhook)
|
webhook | uuid |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
pièce d'identité
|
id | uuid | |
|
nom
|
name | string |
doit adhérer à RFC 7230 |
|
order
|
order | integer | |
|
value
|
value | string |
doit adhérer à RFC 7230 |
|
point d'ancrage web (webhook)
|
webhook | uuid |
Mettre à jour une personne
Mettez à jour la personne avec de nouvelles données. Notez que tous les canaux de contact omis de cette demande seront SUPPRIMÉs. Si vous ne souhaitez pas remplacer toutes les données sur la personne, vous souhaitez probablement utiliser PATCH à la place.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de personne
|
personId | True | uuid |
ID qui identifie de façon unique la personne |
|
Messagerie électronique
|
||||
|
pièce d'identité
|
id | uuid | ||
|
gentil
|
kind | string |
em pour l’e-mail. mp pour téléphone. |
|
|
phone
|
phone | phone | ||
|
pièce d'identité
|
id | uuid | ||
|
is_user
|
is_user | boolean |
True si cette personne est associée à un utilisateur BlueInk |
|
|
metadata
|
metadata | object |
Métadonnées à associer à cette personne. Les métadonnées peuvent être utilisées dans SmartFill pour remplir automatiquement des documents. Pour plus d’informations, consultez la documentation SmartFill. |
|
|
nom
|
name | string |
Nom de la personne |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
channels
|
channels | array of object | |
|
Messagerie électronique
|
channels.email | ||
|
pièce d'identité
|
channels.id | uuid | |
|
gentil
|
channels.kind | string |
em pour l’e-mail. mp pour téléphone. |
|
phone
|
channels.phone | phone | |
|
pièce d'identité
|
id | uuid | |
|
is_user
|
is_user | boolean |
True si cette personne est associée à un utilisateur BlueInk |
|
metadata
|
metadata | object |
Métadonnées à associer à cette personne. Les métadonnées peuvent être utilisées dans SmartFill pour remplir automatiquement des documents. Pour plus d’informations, consultez la documentation SmartFill. |
|
nom
|
name | string |
Nom de la personne |
Obtenir un secret partagé webhook
Obtenir le secret partagé webhook
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
create_date
|
create_date | date-time | |
|
secret
|
secret | b58 |
Récupérer des données groupées
Obtenir des données entrées dans des champs pour un bundle terminé
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Bundle Slug
|
bundleSlug | True | string |
Le slug qui identifie de façon unique le bundle |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
attachments
|
attachments | array of object |
Tableau de pièces jointes de fichier pour un champ de pièce jointe ou null |
|
Poste
|
attachments.ext | string |
Extension de fichier |
|
is_image
|
attachments.is_image | boolean |
true si ce fichier de pièce jointe est une image |
|
nom
|
attachments.name | string |
Nom de fichier de la pièce jointe |
|
Num
|
attachments.num | integer |
Ordre dans lequel le fichier a été ajouté, s’il y a plusieurs chargements pour un champ de pièce jointe unique (par exemple, une photo pour chaque page d’un document pris avec une webcam) |
|
size
|
attachments.size | integer |
Taille du fichier, en octets |
|
URL
|
attachments.url | url |
URL qui peut être utilisée temporairement pour télécharger le fichier de pièce jointe |
|
doc_key
|
doc_key | string |
Clé identifiant de façon unique ce document dans le bundle (à partir de l’original BundleRequest) |
|
field_key
|
field_key | string |
Clé identifiant de manière unique le champ dans le document (tel que spécifié dans le DocumentRequestField d’origine dans DocumentRequest dans BundleRequest, ou configuré sur DocumentTemplate) |
|
filled_by
|
filled_by | string |
Clé de paquet du signataire qui a entré la valeur de ce champ. Si la valeur du champ était un « initial_value » non modifié par un signataire, la valeur est « initiale ». Si la valeur du champ était la valeur par défaut configurée sur un DocumentTemplate, le remplissage est « default ». |
|
gentil
|
kind | string |
Type de champ |
|
label
|
label | string |
Étiquette du champ (éventuellement vide) |
|
packet_id
|
packet_id |
ID de paquet du signataire qui a entré la valeur de ce champ, ou null si la valeur du champ n’a pas été renseignée par un signataire (c’est-à-dire, il s’agissait d’une valeur initial_value ou defaul). |
|
|
value
|
value |
La valeur du champ . |
Récupérer des fichiers groupés
Obtenir des fichiers téléchargeables pour un bundle terminé
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Bundle Slug
|
bundleSlug | True | string |
Le slug qui identifie de façon unique le bundle |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
Expire
|
expires | string |
Heure à laquelle le lien expire, en tant qu’heure mise en forme ISO 8601 |
|
file_url
|
file_url | string |
URL à partir de laquelle le fichier peut être téléchargé |
Récupérer le certificat de preuve de paquet
Obtenir un lien et une somme de contrôle du certificat de preuve pour ce paquet
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Slug de paquet
|
packetId | True | string |
Le slug qui identifie de façon unique le paquet |
Récupérer un bundle
Récupérer un bundle par slug
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Bundle Slug
|
bundleSlug | True | string |
Le slug qui identifie de façon unique le bundle |
Récupérer un modèle de document
Récupérer un modèle de document
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de modèle
|
templateId | True | uuid |
ID qui identifie de façon unique le modèle |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
fields
|
fields | array of |
Tableau de champs placés sur le document. Notez que les champs DocumentTemplate sont légèrement différents des champs DocumentRequest, ayant une |
|
file_url
|
file_url | string |
URL du fichier d’origine qui sert de base pour ce modèle |
|
is_shared
|
is_shared | boolean |
True si le modèle de document est partagé. Faux sinon |
|
nom
|
name | string |
Nom du document. Par défaut, le nom de fichier ou le document lors du chargement, mais peut être défini sur un nom convivial. |
|
roles
|
roles | array of object | |
|
key
|
roles.key | string |
Chaîne unique pour ce document qui identifie ce rôle |
|
label
|
roles.label | string |
Étiquette conviviale pour ce rôle |
Récupérer un Webhook
Obtenir un Webhook par ID
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Webhook ID
|
webhookId | True | uuid |
ID qui identifie de manière unique le Webhook |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
enabled
|
enabled | boolean | |
|
event_types
|
event_types | array of string |
types d’événements qui déclenchent le webhook |
|
extra_headers
|
extra_headers | array of object | |
|
pièce d'identité
|
extra_headers.id | uuid | |
|
nom
|
extra_headers.name | string |
doit adhérer à RFC 7230 |
|
order
|
extra_headers.order | integer | |
|
value
|
extra_headers.value | string |
doit adhérer à RFC 7230 |
|
point d'ancrage web (webhook)
|
extra_headers.webhook | uuid | |
|
pièce d'identité
|
id | uuid | |
|
json
|
json | boolean | |
|
URL
|
url | url |
doit être l’URL complète, y compris http/https |
Récupérer un WebhookExtraHeader
Récupérer les détails d’un WebhookExtraHeader
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
WebhookExtraHeader ID
|
webhookExtraHeaderId | True | uuid |
ID qui identifie de façon unique le WebhookExtraHeader |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
pièce d'identité
|
id | uuid | |
|
nom
|
name | string |
doit adhérer à RFC 7230 |
|
order
|
order | integer | |
|
value
|
value | string |
doit adhérer à RFC 7230 |
|
point d'ancrage web (webhook)
|
webhook | uuid |
Récupérer une personne
Obtenir une personne par ID
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de personne
|
personId | True | uuid |
ID qui identifie de façon unique la personne |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
channels
|
channels | array of object | |
|
Messagerie électronique
|
channels.email | ||
|
pièce d'identité
|
channels.id | uuid | |
|
gentil
|
channels.kind | string |
em pour l’e-mail. mp pour téléphone. |
|
phone
|
channels.phone | phone | |
|
pièce d'identité
|
id | uuid | |
|
is_user
|
is_user | boolean |
True si cette personne est associée à un utilisateur BlueInk |
|
metadata
|
metadata | object |
Métadonnées à associer à cette personne. Les métadonnées peuvent être utilisées dans SmartFill pour remplir automatiquement des documents. Pour plus d’informations, consultez la documentation SmartFill. |
|
nom
|
name | string |
Nom de la personne |
Régénérer le secret partagé webhook
Régénérer le secret partagé webhook
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
create_date
|
create_date | date-time | |
|
secret
|
secret | b58 |
Répertorier les bundles
Retourne une liste paginé d’offres groupées dans votre compte, triée par date de création (de la plus récente à la plus récente). La pagination peut être contrôlée via des paramaters pagination (voir Overview-Pagination>).
Les filtres querystring peuvent être combinés, par exemple /bundles/?search=Gibbons&status__in=se,co&tag=needs-attention. Lors de la combinaison de filtres, seuls les bundles correspondant à TOUS les filtres sont retournés.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Requête de recherche
|
search | string |
Requête de recherche. Seuls les bundles correspondant à la recherche sont retournés. Les données suivantes dans le bundle sont recherchées :
Par exemple, |
|
|
État de l’offre groupée
|
status | string |
Limitez les bundles à ceux dont l’état est spécifié.
Par exemple, |
|
|
Liste de l’état de l’offre groupée
|
status__in | string |
Limitez les bundles à ceux avec l’un des états spécifiés. Les états doivent être séparés par des virgules.
Par exemple, |
|
|
Balise d’offre groupée
|
tag | string |
Retourne des bundles qui ont la balise donnée. Par exemple, |
|
|
Liste des étiquettes groupées
|
tag__in | string |
Retourne des bundles qui ont au moins l’une des balises données. Les balises doivent être séparées par des virgules.
Par exemple, |
|
|
Ordre de tri de bundle
|
ordering | string |
Contrôlez l’ordre de tri des bundles. Préfixe avec « - » pour inverser l’ordre de tri. Par défaut, les bundles sont triés par « -created », c’est-à-dire que la date de création du bundle est la plus récente. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
|
array of |
Répertorier les modèles de documents
Répertorier tous les modèles de document
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
fields
|
fields | array of |
Tableau de champs placés sur le document. Notez que les champs DocumentTemplate sont légèrement différents des champs DocumentRequest, ayant une |
|
file_url
|
file_url | string |
URL du fichier d’origine qui sert de base pour ce modèle |
|
is_shared
|
is_shared | boolean |
True si le modèle de document est partagé. Faux sinon |
|
nom
|
name | string |
Nom du document. Par défaut, le nom de fichier ou le document lors du chargement, mais peut être défini sur un nom convivial. |
|
roles
|
roles | array of object | |
|
key
|
roles.key | string |
Chaîne unique pour ce document qui identifie ce rôle |
|
label
|
roles.label | string |
Étiquette conviviale pour ce rôle |
Répertorier les webhooks
Répertorier tous les webhooks dans votre compte BlueInk
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Enabled
|
enabled | boolean |
Seuls les Webhooks correspondant à l’état « activé » sélectionné sont retournés. Par exemple, |
|
|
Type d'événement
|
event_type | string |
Seuls les webhooks correspondant aux event_type sélectionnés ou event_types sont retournés. Par exemple, |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
enabled
|
enabled | boolean | |
|
event_types
|
event_types | array of string |
types d’événements qui déclenchent le webhook |
|
extra_headers
|
extra_headers | array of object | |
|
pièce d'identité
|
extra_headers.id | uuid | |
|
nom
|
extra_headers.name | string |
doit adhérer à RFC 7230 |
|
order
|
extra_headers.order | integer | |
|
value
|
extra_headers.value | string |
doit adhérer à RFC 7230 |
|
point d'ancrage web (webhook)
|
extra_headers.webhook | uuid | |
|
pièce d'identité
|
id | uuid | |
|
json
|
json | boolean | |
|
URL
|
url | url |
doit être l’URL complète, y compris http/https |
Répertorier les événements groupés
Obtenir la liste des événements associés à l’offre groupée
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Bundle Slug
|
bundleSlug | True | string |
Le slug qui identifie de façon unique le bundle |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
descriptif
|
description | string |
Une brève désiption de l’événement |
|
gentil
|
kind | string |
Type de l’événement sous la forme d’un code de 2 caractères |
|
packet_id
|
packet_id | uuid |
UUID d’un paquet. Présente uniquement si l’événement est associé à un paquet particulier. |
|
horodatage
|
timestamp | date-time |
Heure à laquelle l’événement s’est produit |
Répertorier webhookEvents
Répertorier tous les événements Webhook dans votre compte BlueInk
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Webhook ID
|
webhook | uuid |
Seuls les WebhookEvents correspondant à l’ID de webhook sélectionné sont retournés. Par exemple, |
|
|
Type d'événement
|
event_type | string |
Seuls les WebhookEvents avec des webhooks correspondant aux event_type sélectionnés ou event_types sont retournés. Par exemple, |
|
|
Statut
|
status | integer |
Seuls les WebhookEvents correspondant à l’état sélectionné sont retournés. Par exemple, |
|
|
Résultat de la réussite
|
success | boolean |
Seuls les WebhookEvents correspondant à l’état de réussite sélectionné sont retournés. Par exemple, |
|
|
Plage de dates
|
date | date-time |
Seuls les WebhookEvents qui se produisent entre une plage de dates sont retournés. Remarque : Les dates sont exprimées sous forme de format aaaa-MM-DD. Par exemple, |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
créé
|
created | date-time | |
|
Livraisons
|
deliveries | array of object | |
|
Message
|
deliveries.message | string |
message décrivant tous les problèmes |
|
Pk
|
deliveries.pk | uuid | |
|
status
|
deliveries.status | integer |
message d’état de la réponse ou 0 si aucun état |
|
horodatage
|
deliveries.timestamp | date-time |
lorsque la tentative de remise s’est produite (début de la tentative, et non lorsqu’elle a échoué, par exemple pour un délai d’expiration) |
|
event_type
|
event_type | string | |
|
payload
|
payload | string |
la charge utile à envoyer lors de la livraison ; json |
|
Pk
|
pk | uuid | |
|
status
|
status | integer |
code d’état de la dernière réponse du point de terminaison webhook. 0 indique qu’aucune réponse n’a été reçue |
|
success
|
success | boolean | |
|
point d'ancrage web (webhook)
|
webhook | uuid |
UUID identifiant le webhook auquel l’événement appartient |
Répertorier webhookEvents
Répertorier tous les WebhookDeliveries dans votre compte BlueInk
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Webhook ID
|
webhook | uuid |
Seuls WebhookDeliveries correspondant à l’ID de webhook sélectionné sont retournés. Par exemple, |
|
|
ID d’événement Webhook
|
webhook_event | uuid |
Seuls WebhookDeliveries correspondant à l’ID de webhook_event sélectionné sont retournés. Par exemple, |
|
|
Type d'événement
|
event_type | string |
Seuls WebhookDeliveries avec des webhooks correspondant aux event_type sélectionnés ou event_types seront retournés. Par exemple, |
|
|
Statut
|
status | integer |
Seuls WebhookDeliveries correspondant à l’état sélectionné sont retournés. Par exemple, |
|
|
Plage de dates
|
date | date-time |
Seuls WebhookDeliveries se produisant entre une plage de dates sont retournés. Remarque : Les dates sont exprimées sous forme de format aaaa-MM-DD. Par exemple, |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
créé
|
created | date-time | |
|
Livraisons
|
deliveries | array of object | |
|
Message
|
deliveries.message | string |
message décrivant tous les problèmes |
|
Pk
|
deliveries.pk | uuid | |
|
status
|
deliveries.status | integer |
message d’état de la réponse ou 0 si aucun état |
|
horodatage
|
deliveries.timestamp | date-time |
lorsque la tentative de remise s’est produite (début de la tentative, et non lorsqu’elle a échoué, par exemple pour un délai d’expiration) |
|
event_type
|
event_type | string | |
|
payload
|
payload | string |
la charge utile à envoyer lors de la livraison ; json |
|
Pk
|
pk | uuid | |
|
status
|
status | integer |
code d’état de la dernière réponse du point de terminaison webhook. 0 indique qu’aucune réponse n’a été reçue |
|
success
|
success | boolean | |
|
point d'ancrage web (webhook)
|
webhook | uuid |
UUID identifiant le webhook auquel l’événement appartient |
Répertorier WebhookExtraHeaders
Répertorier tous les WebhookExtraHeaders dans votre compte BlueInk
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Webhook ID
|
webhook | uuid |
Seuls les WebhookExtraHeaders correspondant à l’ID de webhook sélectionné sont retournés. Par exemple, |
|
|
Type d'événement
|
event_type | string |
Seuls WebhookExtraHeaders avec des webhooks correspondant à la event_type sélectionnée ou event_types seront retournés. Par exemple, |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
pièce d'identité
|
id | uuid | |
|
nom
|
name | string |
doit adhérer à RFC 7230 |
|
order
|
order | integer | |
|
value
|
value | string |
doit adhérer à RFC 7230 |
|
point d'ancrage web (webhook)
|
webhook | uuid |
Supprimer des balises d’un bundle
Supprimez les balises d’un bundle. Si une balise dans la demande n’existe pas sur le bundle, elle est ignorée.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Bundle Slug
|
bundleSlug | True | string |
Le slug qui identifie de façon unique le bundle |
|
tags
|
tags | array of string |
Tableau de balises |
Supprimer un webhook
Supprimer un Webhook par ID
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Webhook ID
|
webhookId | True | uuid |
ID qui identifie de manière unique le Webhook |
Supprimer un WebhookExtraHeader
Supprimer un WebhookExtraHeader
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
WebhookExtraHeader ID
|
webhookExtraHeaderId | True | uuid |
ID qui identifie de façon unique le WebhookExtraHeader |
Supprimer une personne
Supprimez une personne. Cela supprime également tout utilisateur BlueInk associé.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de personne
|
personId | True | uuid |
ID qui identifie de façon unique la personne |