> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.goodflag.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.goodflag.com/_mcp/server. # Renvoyer une invitation sur un parapheur refusé POST https://workflow-manager/api/workflows/{workflowId}/steps/{stepId}/refuseUnlock Content-Type: application/json Renvoie une invitation à un signataire ou un validateur d'un parapheur existant refusé. `workflowManager` Également autorisés sans rôle : les membres d'un groupe autorisé, le propriétaire. Reference: https://docs.goodflag.com/wm/api-reference/documentation-api/token-portail/workflows/resend-an-invitation-to-the-rejected-workflow ## Authentication - `Authorization` header (bearer token, required) — Authentification Bearer par jeton utilisateur ou jeton d'accès : `Authorization: Bearer `. ## Request ### Path parameters - `workflowId` (string, required) — L'identifiant du parapheur. - `stepId` (string, required) — L'identifiant de l'étape. ### Body (application/json) This endpoint expects an object. - `recipientEmail` (string, required) — L'adresse email du destinataire du parapheur. - `recipientUserId` (string, optional) — L'identifiant de l'utilisateur destinataire du parapheur. ## Response ### 200 L'invitation a été renvoyée. - `id` (string, required) — L'identifiant du parapheur. - `tenantId` (string, required) — L'identifiant du tenant auquel appartient le parapheur. - `groupId` (string, required) — L'identifiant du groupe auquel appartient le parapheur. - `userId` (string, required) — L'identifiant de l'utilisateur auquel appartient le parapheur. - `email` (string, required) — L'adresse email de l'utilisateur propriétaire du parapheur. - `pictureResourceId` (string, required) — L'identifiant de la ressource photo de l'utilisateur propriétaire du parapheur. - `firstName` (string, required) — Le prénom de l'utilisateur propriétaire du parapheur. - `lastName` (string, required) — Le nom de l'utilisateur propriétaire du parapheur. - `viewAuthorizedGroups` (list of any, required) — La liste des identifiants de groupes dont les membres peuvent consulter ce parapheur. - `viewAuthorizedUsers` (list of any, required) — La liste des identifiants d'utilisateurs autorisés à consulter ce parapheur. - `name` (string, required) — Le nom du parapheur. - `logs` (list of any, required) — Les journaux du parapheur. - `steps` (list of any, required) — Les étapes du parapheur. - `steps[].id` (string, required) — L'identifiant de l'étape. - `steps[].stepType` (string, required) — Le type de l'étape : signature ou approval. - `steps[].recipients` (list of any, required) — La liste des destinataires appelés à signer ou valider les documents. - `steps[].recipients[].consentPageId` (string, required) — L'identifiant de la page de consentement à utiliser pour la requête. - `steps[].recipients[].email` (string, required) — L'adresse email du destinataire. - `steps[].recipients[].firstName` (string, required) — Le prénom du destinataire. - `steps[].recipients[].lastName` (string, required) — Le nom du destinataire. - `steps[].recipients[].country` (string, required) — Le pays de l'utilisateur. - `steps[].requiredRecipients` (double, required) — Le nombre de destinataires devant signer ou valider les documents pour que l'étape se termine. - `steps[].validityPeriod` (double, required) — La durée de validité de l'étape. - `steps[].invitePeriod` (double, required) — Le délai après lequel les invitations sont renvoyées. - `steps[].maxInvites` (double, required) — Le nombre maximal d'invitations envoyées aux destinataires. - `steps[].sendDownloadLink` (boolean, required) — Indique si les signataires ou les validateurs reçoivent un lien de téléchargement des documents signés à la fin du parapheur. - `steps[].isStarted` (boolean, required) — Indique si l'étape est démarrée. - `steps[].isFinished` (boolean, required) — Indique si l'étape est terminée. - `steps[].allowComments` (boolean, required) — Indique si les destinataires de l'étape sont autorisés à consulter et créer des commentaires. - `steps[].hideAttachments` (boolean, required) — Indique si les pièces jointes sont affichées aux destinataires de l'étape. - `steps[].viewConfidentialAttachments` (boolean, required) — Indique si les pièces jointes confidentielles sont affichées aux destinataires de l'étape. - `steps[].hideWorkflowRecipients` (boolean, required) — Indique si les autres destinataires du parapheur sont visibles par les destinataires de cette étape. - `steps[].logs` (list of any, required) — Les journaux de l'étape. - `currentRecipientEmails` (list of any, required) — La liste des adresses email des destinataires actuellement invités à signer ou valider. - `currentRecipientUsers` (list of any, required) — La liste des utilisateurs destinataires actuellement invités à signer ou valider. - `notifiedEvents` (list of any, required) — Les types d'événements pour lesquels le propriétaire reçoit des notifications. - `watchers` (list of any, required) — La liste des observateurs du parapheur. - `watchers[].notifiedEvents` (list of any, required) — Les types d'événements pour lesquels l'observateur reçoit des notifications. - `workflowStatus` (enum, required) — Le statut du parapheur. - Allowed values: `draft`, `started`, `stopped`, `finished`, `archived` - `progress` (double, required) — L'avancement du parapheur. - `dynamicFields[].id` (string, required) — Identifiant du champ dynamique. - `dynamicFields[].type` (string, required) — Type du champ dynamique. Valeurs possibles : TEXT. - `dynamicFields[].name` (string, required) — Nom du champ dynamique. - `dynamicFields[].order` (integer, required) — Ordre du champ dynamique. - `dynamicFields[].instances[].id` (string, required) — Identifiants des instances du champ dynamique. - `dynamicFields[].instances[].documentId` (string, required) — Identifiant du document auquel les instances du champ dynamique s'appliquent. - `dynamicFields[].instances[].documentPage` (integer, required) — Page du document à laquelle les instances du champ dynamique s'appliquent. - `dynamicFields[].instances[].posX` (integer, required) — Position sur l'axe X appliquée aux instances du champ dynamique. - `dynamicFields[].instances[].posY` (integer, required) — Position sur l'axe Y appliquée aux instances du champ dynamique. - `dynamicFields[].instances[].font` (string, required) — Police appliquée aux instances du champ dynamique. - `dynamicFields[].instances[].color` (string, required) — Couleur appliquée aux instances du champ dynamique. - `dynamicFields[].instances[].size` (integer, required) — Taille de police appliquée aux instances du champ dynamique. - `workflowMode` (enum, required) — Le mode du parapheur. - Allowed values: `FULL`, `SINGLE_SIGNER` - `created` (double, required) — La date de création de l'entité. - `updated` (double, required) — La date de dernière modification de l'entité. - `description` (string, optional) — La description du parapheur. - `layoutId` (string, optional) — La disposition utilisée pour les champs de métadonnées. - `data1` (string, optional) — La valeur du champ de métadonnée data1. - `data2` (string, optional) — La valeur du champ de métadonnée data2. - `data3` (string, optional) — La valeur du champ de métadonnée data3. - `data4` (string, optional) — La valeur du champ de métadonnée data4. - `data5` (string, optional) — La valeur du champ de métadonnée data5. - `data6` (string, optional) — La valeur du champ de métadonnée data6. - `data7` (string, optional) — La valeur du champ de métadonnée data7. - `data8` (string, optional) — La valeur du champ de métadonnée data8. - `data9` (string, optional) — La valeur du champ de métadonnée data9. - `data10` (string, optional) — La valeur du champ de métadonnée data10. - `data11` (string, optional) — La valeur du champ de métadonnée data11. - `data12` (string, optional) — La valeur du champ de métadonnée data12. - `data13` (string, optional) — La valeur du champ de métadonnée data13. - `data14` (string, optional) — La valeur du champ de métadonnée data14. - `data15` (string, optional) — La valeur du champ de métadonnée data15. - `data16` (string, optional) — La valeur du champ de métadonnée data16. - `steps[].recipients[].userId` (string, optional) — L'identifiant de l'utilisateur destinataire, lorsque le destinataire est un utilisateur. - `steps[].recipients[].pictureResourceId` (string, optional) — L'identifiant de la ressource photo de l'utilisateur, lorsque le destinataire est un utilisateur. - `steps[].recipients[].phoneNumber` (string, optional) — Le numéro de téléphone international du destinataire. - `steps[].recipients[].comments` (string, optional) — Les commentaires associés au contact. - `steps[].recipients[].organizationId` (string, optional) — L'identifiant de l'organisation pour le compte de laquelle la signature est apposée. - `steps[].recipients[].preferredLocale` (string, optional) — La locale préférée pour les emails de notification envoyés au destinataire. - `steps[].requireSupportingDocuments` (boolean, optional) — Indique si le dépôt de pièces justificatives est requis pour cette étape. - `steps[].supportingDocumentsList` (string, optional) — La liste des pièces justificatives que le signataire doit fournir (5 au maximum). Requis uniquement si requireSupportingDocuments vaut true. - `steps[].supportingDocumentIds` (list of any, optional) — La liste des identifiants des pièces justificatives liées à cette étape. - `steps[].supportingDocuments` (list of any, optional) — La liste des pièces justificatives liées à cette étape. - `steps[].disableMandatoryViewing` (boolean, optional) — Indique si la consultation obligatoire des documents est désactivée pour cette étape. - `steps[].faceToFaceSignature` (boolean, optional) — Indique si l'étape utilise le mode de signature en face-à-face. - `watchers[].userId` (string, optional) — L'identifiant de l'utilisateur, lorsque l'observateur est un utilisateur. - `watchers[].email` (string, optional) — L'adresse email de l'observateur, lorsqu'il n'est pas un utilisateur. - `started` (double, optional) — La date du premier démarrage du parapheur. - `stopped` (double, optional) — La date d'arrêt du parapheur. (Renseignée uniquement lorsque workflowMode = SINGLE_SIGNER) - `finished` (double, optional) — La date d'achèvement du parapheur. (Renseignée uniquement lorsque workflowMode = SINGLE_SIGNER) - `closed` (double, optional) — La date de clôture du parapheur. (Renseignée uniquement lorsque workflowMode = SINGLE_SIGNER) - `templateId` (string, optional) — L'identifiant du modèle de parapheur. - `allowedCoManagerUsers` (list of any, optional) — La liste des cogestionnaires pouvant être désignés sur le parapheur. - `coManagerNotifiedEvents` (list of any, optional) — Les types d'événements pour lesquels le cogestionnaire reçoit des notifications. - `allowConsolidation` (boolean, optional) — Indique si la consolidation du parapheur est activée. - `dynamicFields` (string, optional) — Liste des champs dynamiques. - `dynamicFields[].description` (string, optional) — Description du champ dynamique. - `dynamicFields[].value` (string, optional) — Valeur du champ dynamique. - `dynamicFields[].instances` (string, optional) — Instances des champs dynamiques. - `jobOperation` (string, optional) — L'opération de tâche en cours d'exécution. ## Errors ### 403 Forbidden Error AuthenticatedUserDisabled : L'utilisateur authentifié est désactivé. ; MissingBearerToken : Un jeton Bearer est requis. ; RecipientRefuseUnlockNotAllowed : Une invitation ne peut pas être renvoyée à ce destinataire. ; TenantInactive : Le tenant est inactif et n'autorise aucune opération. ; UserGroupDisabled : Le groupe de l'utilisateur spécifié est désactivé. ; UserNotAllowed : L'utilisateur authentifié n'est pas autorisé à effectuer cette opération. - `status` (integer, required) — Le code de statut HTTP. - `error` (string, required) — Le message de statut HTTP. - `message` (string, required) — Le message d'erreur. - `code` (string, required) — Le code d'erreur. ## Examples **Request** ```json { "recipientEmail": "string" } ``` **Response** ```json { "id": "string", "tenantId": "string", "groupId": "string", "userId": "string", "email": "string", "pictureResourceId": "string", "firstName": "string", "lastName": "string", "viewAuthorizedGroups": [ null ], "viewAuthorizedUsers": [ null ], "name": "string", "logs": [ null ], "steps": [ null ], "steps[].id": "string", "steps[].stepType": "string", "steps[].recipients": [ null ], "steps[].recipients[].consentPageId": "string", "steps[].recipients[].email": "string", "steps[].recipients[].firstName": "string", "steps[].recipients[].lastName": "string", "steps[].recipients[].country": "string", "steps[].requiredRecipients": 1.1, "steps[].validityPeriod": 1.1, "steps[].invitePeriod": 1.1, "steps[].maxInvites": 1.1, "steps[].sendDownloadLink": true, "steps[].isStarted": true, "steps[].isFinished": true, "steps[].allowComments": true, "steps[].hideAttachments": true, "steps[].viewConfidentialAttachments": true, "steps[].hideWorkflowRecipients": true, "steps[].logs": [ null ], "currentRecipientEmails": [ null ], "currentRecipientUsers": [ null ], "notifiedEvents": [ null ], "watchers": [ null ], "watchers[].notifiedEvents": [ null ], "workflowStatus": "draft", "progress": 1.1, "dynamicFields[].id": "string", "dynamicFields[].type": "string", "dynamicFields[].name": "string", "dynamicFields[].order": 1, "dynamicFields[].instances[].id": "string", "dynamicFields[].instances[].documentId": "string", "dynamicFields[].instances[].documentPage": 1, "dynamicFields[].instances[].posX": 1, "dynamicFields[].instances[].posY": 1, "dynamicFields[].instances[].font": "string", "dynamicFields[].instances[].color": "string", "dynamicFields[].instances[].size": 1, "workflowMode": "FULL", "created": 1.1, "updated": 1.1, "description": "string", "layoutId": "string", "data1": "string", "data2": "string", "data3": "string", "data4": "string", "data5": "string", "data6": "string", "data7": "string", "data8": "string", "data9": "string", "data10": "string", "data11": "string", "data12": "string", "data13": "string", "data14": "string", "data15": "string", "data16": "string", "steps[].recipients[].userId": "string", "steps[].recipients[].pictureResourceId": "string", "steps[].recipients[].phoneNumber": "string", "steps[].recipients[].comments": "string", "steps[].recipients[].organizationId": "string", "steps[].recipients[].preferredLocale": "string", "steps[].requireSupportingDocuments": true, "steps[].supportingDocumentsList": "string", "steps[].supportingDocumentIds": [ null ], "steps[].supportingDocuments": [ null ], "steps[].disableMandatoryViewing": true, "steps[].faceToFaceSignature": true, "watchers[].userId": "string", "watchers[].email": "string", "started": 1.1, "stopped": 1.1, "finished": 1.1, "closed": 1.1, "templateId": "string", "allowedCoManagerUsers": [ null ], "coManagerNotifiedEvents": [ null ], "allowConsolidation": true, "dynamicFields": "string", "dynamicFields[].description": "string", "dynamicFields[].value": "string", "dynamicFields[].instances": "string", "jobOperation": "string" } ``` **SDK Code** ```python import requests url = "https://workflow-manager/api/workflows/workflowId/steps/stepId/refuseUnlock" payload = { "recipientEmail": "string" } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://workflow-manager/api/workflows/workflowId/steps/stepId/refuseUnlock'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"recipientEmail":"string"}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://workflow-manager/api/workflows/workflowId/steps/stepId/refuseUnlock" payload := strings.NewReader("{\n \"recipientEmail\": \"string\"\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://workflow-manager/api/workflows/workflowId/steps/stepId/refuseUnlock") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"recipientEmail\": \"string\"\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://workflow-manager/api/workflows/workflowId/steps/stepId/refuseUnlock") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"recipientEmail\": \"string\"\n}") .asString(); ``` ```php request('POST', 'https://workflow-manager/api/workflows/workflowId/steps/stepId/refuseUnlock', [ 'body' => '{ "recipientEmail": "string" }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://workflow-manager/api/workflows/workflowId/steps/stepId/refuseUnlock"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"recipientEmail\": \"string\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = ["recipientEmail": "string"] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://workflow-manager/api/workflows/workflowId/steps/stepId/refuseUnlock")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```