Renvoyer une invitation sur un parapheur refusé

Afficher en Markdown
Renvoie une invitation à un signataire ou un validateur d'un parapheur existant refusé. <Note title="Rôle requis"> `workflowManager` Également autorisés sans rôle : les membres d'un groupe autorisé, le propriétaire. </Note>

Authentification

AuthorizationBearer

Authentification Bearer par jeton utilisateur ou jeton d’accès : Authorization: Bearer <token>.

Paramètres de chemin

workflowIdstringRequis
L'identifiant du parapheur.
stepIdstringRequis

L’identifiant de l’étape.

Requête

This endpoint expects an object.
recipientEmailstringRequis
L'adresse email du destinataire du parapheur.
recipientUserIdstringOptionnel
L'identifiant de l'utilisateur destinataire du parapheur.

Réponse

L’invitation a été renvoyée.

idstring
L'identifiant du parapheur.
tenantIdstring
L'identifiant du tenant auquel appartient le parapheur.
groupIdstring
L'identifiant du groupe auquel appartient le parapheur.
userIdstring
L'identifiant de l'utilisateur auquel appartient le parapheur.
emailstring

L’adresse email de l’utilisateur propriétaire du parapheur.

pictureResourceIdstring

L’identifiant de la ressource photo de l’utilisateur propriétaire du parapheur.

firstNamestring

Le prénom de l’utilisateur propriétaire du parapheur.

lastNamestring

Le nom de l’utilisateur propriétaire du parapheur.

viewAuthorizedGroupslist of any
La liste des identifiants de groupes dont les membres peuvent consulter ce parapheur.
viewAuthorizedUserslist of any

La liste des identifiants d’utilisateurs autorisés à consulter ce parapheur.

namestring
Le nom du parapheur.
logslist of any
Les journaux du parapheur.
stepslist of any

Les étapes du parapheur.

steps[].idstring

L’identifiant de l’étape.

steps[].stepTypestring

Le type de l’étape : signature ou approval.

steps[].recipientslist of any

La liste des destinataires appelés à signer ou valider les documents.

steps[].recipients[].consentPageIdstring

L’identifiant de la page de consentement à utiliser pour la requête.

steps[].recipients[].emailstring
L'adresse email du destinataire.
steps[].recipients[].firstNamestring

Le prénom du destinataire.

steps[].recipients[].lastNamestring
Le nom du destinataire.
steps[].recipients[].countrystring
Le pays de l'utilisateur.
steps[].requiredRecipientsdouble

Le nombre de destinataires devant signer ou valider les documents pour que l’étape se termine.

steps[].validityPerioddouble

La durée de validité de l’étape.

steps[].invitePerioddouble

Le délai après lequel les invitations sont renvoyées.

steps[].maxInvitesdouble

Le nombre maximal d’invitations envoyées aux destinataires.

steps[].isStartedboolean

Indique si l’étape est démarrée.

steps[].isFinishedboolean

Indique si l’étape est terminée.

steps[].allowCommentsboolean

Indique si les destinataires de l’étape sont autorisés à consulter et créer des commentaires.

steps[].hideAttachmentsboolean

Indique si les pièces jointes sont affichées aux destinataires de l’étape.

steps[].viewConfidentialAttachmentsboolean

Indique si les pièces jointes confidentielles sont affichées aux destinataires de l’étape.

steps[].hideWorkflowRecipientsboolean

Indique si les autres destinataires du parapheur sont visibles par les destinataires de cette étape.

steps[].logslist of any

Les journaux de l’étape.

currentRecipientEmailslist of any

La liste des adresses email des destinataires actuellement invités à signer ou valider.

currentRecipientUserslist of any

La liste des utilisateurs destinataires actuellement invités à signer ou valider.

notifiedEventslist of any

Les types d’événements pour lesquels le propriétaire reçoit des notifications.

watcherslist of any
La liste des observateurs du parapheur.
watchers[].notifiedEventslist of any

Les types d’événements pour lesquels l’observateur reçoit des notifications.

workflowStatusenum
Le statut du parapheur.
progressdouble
L'avancement du parapheur.
dynamicFields[].idstring
Identifiant du champ dynamique.
dynamicFields[].typestring

Type du champ dynamique. Valeurs possibles : TEXT.

dynamicFields[].namestring
Nom du champ dynamique.
dynamicFields[].orderinteger
Ordre du champ dynamique.
dynamicFields[].instances[].idstring
Identifiants des instances du champ dynamique.
dynamicFields[].instances[].documentIdstring
Identifiant du document auquel les instances du champ dynamique s'appliquent.
dynamicFields[].instances[].documentPageinteger

Page du document à laquelle les instances du champ dynamique s’appliquent.

dynamicFields[].instances[].posXinteger

Position sur l’axe X appliquée aux instances du champ dynamique.

dynamicFields[].instances[].posYinteger

Position sur l’axe Y appliquée aux instances du champ dynamique.

dynamicFields[].instances[].fontstring

Police appliquée aux instances du champ dynamique.

dynamicFields[].instances[].colorstring

Couleur appliquée aux instances du champ dynamique.

dynamicFields[].instances[].sizeinteger

Taille de police appliquée aux instances du champ dynamique.

workflowModeenum
Le mode du parapheur.
createddouble

La date de création de l’entité.

updateddouble

La date de dernière modification de l’entité.

descriptionstringOptionnel
La description du parapheur.
layoutIdstringOptionnel

La disposition utilisée pour les champs de métadonnées.

data1stringOptionnel

La valeur du champ de métadonnée data1.

data2stringOptionnel

La valeur du champ de métadonnée data2.

data3stringOptionnel

La valeur du champ de métadonnée data3.

data4stringOptionnel

La valeur du champ de métadonnée data4.

data5stringOptionnel

La valeur du champ de métadonnée data5.

data6stringOptionnel

La valeur du champ de métadonnée data6.

data7stringOptionnel

La valeur du champ de métadonnée data7.

data8stringOptionnel

La valeur du champ de métadonnée data8.

data9stringOptionnel

La valeur du champ de métadonnée data9.

data10stringOptionnel

La valeur du champ de métadonnée data10.

data11stringOptionnel

La valeur du champ de métadonnée data11.

data12stringOptionnel

La valeur du champ de métadonnée data12.

data13stringOptionnel

La valeur du champ de métadonnée data13.

data14stringOptionnel

La valeur du champ de métadonnée data14.

data15stringOptionnel

La valeur du champ de métadonnée data15.

data16stringOptionnel

La valeur du champ de métadonnée data16.

steps[].recipients[].userIdstringOptionnel
L'identifiant de l'utilisateur destinataire, lorsque le destinataire est un utilisateur.
steps[].recipients[].pictureResourceIdstringOptionnel
L'identifiant de la ressource photo de l'utilisateur, lorsque le destinataire est un utilisateur.
steps[].recipients[].phoneNumberstringOptionnel

Le numéro de téléphone international du destinataire.

steps[].recipients[].commentsstringOptionnel

Les commentaires associés au contact.

steps[].recipients[].organizationIdstringOptionnel

L’identifiant de l’organisation pour le compte de laquelle la signature est apposée.

steps[].recipients[].preferredLocalestringOptionnel

La locale préférée pour les emails de notification envoyés au destinataire.

steps[].requireSupportingDocumentsbooleanOptionnel

Indique si le dépôt de pièces justificatives est requis pour cette étape.

steps[].supportingDocumentsListstringOptionnel

La liste des pièces justificatives que le signataire doit fournir (5 au maximum). Requis uniquement si requireSupportingDocuments vaut true.

steps[].supportingDocumentIdslist of anyOptionnel

La liste des identifiants des pièces justificatives liées à cette étape.

steps[].supportingDocumentslist of anyOptionnel

La liste des pièces justificatives liées à cette étape.

steps[].disableMandatoryViewingbooleanOptionnel

Indique si la consultation obligatoire des documents est désactivée pour cette étape.

steps[].faceToFaceSignaturebooleanOptionnel

Indique si l’étape utilise le mode de signature en face-à-face.

watchers[].userIdstringOptionnel
L'identifiant de l'utilisateur, lorsque l'observateur est un utilisateur.
watchers[].emailstringOptionnel
L'adresse email de l'observateur, lorsqu'il n'est pas un utilisateur.
starteddoubleOptionnel

La date du premier démarrage du parapheur.

stoppeddoubleOptionnel

La date d’arrêt du parapheur. (Renseignée uniquement lorsque workflowMode = SINGLE_SIGNER)

finisheddoubleOptionnel

La date d’achèvement du parapheur. (Renseignée uniquement lorsque workflowMode = SINGLE_SIGNER)

closeddoubleOptionnel

La date de clôture du parapheur. (Renseignée uniquement lorsque workflowMode = SINGLE_SIGNER)

templateIdstringOptionnel

L’identifiant du modèle de parapheur.

allowedCoManagerUserslist of anyOptionnel

La liste des cogestionnaires pouvant être désignés sur le parapheur.

coManagerNotifiedEventslist of anyOptionnel

Les types d’événements pour lesquels le cogestionnaire reçoit des notifications.

allowConsolidationbooleanOptionnel

Indique si la consolidation du parapheur est activée.

dynamicFieldsstringOptionnel
Liste des champs dynamiques.
dynamicFields[].descriptionstringOptionnel
Description du champ dynamique.
dynamicFields[].valuestringOptionnel
Valeur du champ dynamique.
dynamicFields[].instancesstringOptionnel
Instances des champs dynamiques.
jobOperationstringOptionnel

L’opération de tâche en cours d’exécution.

Erreurs

403
Forbidden Error