> 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. # Modifier un document PATCH https://workflow-manager/api/documents/{documentId} Content-Type: application/json Modifie un document de parapheur existant. `workflowManager` Également autorisés sans rôle : les membres d'un groupe autorisé, le propriétaire. Également acceptés : jeton de visionneuse. Reference: https://docs.goodflag.com/wm/api-reference/documentation-api/token-portail/workflow-documents/update-document ## Authentication - `Authorization` header (bearer token, required) — Authentification Bearer par jeton utilisateur ou jeton d'accès : `Authorization: Bearer `. ## Request ### Path parameters - `documentId` (string, required) — L'identifiant du document. ### Headers - `If-Match` (string, required) — L'ETag de la ressource, pour le contrôle de concurrence optimiste. ### Body (application/json) This endpoint expects an object. - `signatureProfileId` (string, optional) — Le profil de signature utilisé pour signer le document. S'il est vide, le document est une pièce jointe. - `pdfSignatureFields` (list of object, optional) — Pour un document PDF, la liste des champs de signature que les signataires devront remplir. - `imagePage` (long, optional) — La page du PDF où l'image de signature apparaît, à partir de 1. Une valeur négative compte depuis la dernière page. Ignoré si fieldId est défini. - `imageX` (double, optional) — La position de l'image de signature dans la page PDF (axe X). Ignoré si fieldId est défini. - `imageY` (double, optional) — La position de l'image de signature dans la page PDF (axe Y). Ignoré si fieldId est défini. - `imageWidth` (double, optional) — La largeur (en pixels) de l'image de signature dans la page PDF. Ignoré si fieldId est défini. - `imageHeight` (double, optional) — La hauteur (en pixels) de l'image de signature dans la page PDF. Ignoré si fieldId est défini. - `fieldId` (string, optional) — L'identifiant du champ de signature existant dans le document PDF. - `confidentiality` (boolean, optional) — Le statut de confidentialité des pièces jointes. - `orderIndex` (long, optional) — L'index d'ordre permet de personnaliser l'ordre d'affichage des documents. - `subOrderIndex` (long, optional) — L'index de sous-ordre permet de personnaliser l'ordre d'affichage des documents dans les dossiers. ## Response ### 200 L'entité Document mise à jour. - `created` (long, required) — La date de création de l'entité. - `displayedParts` (list of object, required) — Les parties du document affichées à l'utilisateur final. - `contentType` (string, required) — Le type de contenu de la partie affichée à l'utilisateur final. - `filename` (string, required) — Le nom de fichier de la partie affichée à l'utilisateur final. - `hash` (string, required) — L'empreinte cryptographique de la partie affichée à l'utilisateur final. - `size` (long, required) — La taille de la partie affichée à l'utilisateur final. - `isOriginal` (boolean, optional) — Indique si la partie affichée à l'utilisateur final est une partie originale ou modifiée. - `policyUri` (string, optional) — L'URL d'accès au PDF de la politique de signature. Sans valeur spécifiée, l'URL de la politique de signature par défaut est appliquée. - `visualIdentification` (string, optional) — L'identification visuelle appliquée à la partie. - `groupId` (string, required) — L'identifiant du groupe auquel appartient le document. - `id` (string, required) — L'identifiant du document. - `parts` (list of object, required) — Les parties du document. - `contentType` (string, required) — Le type de contenu de la partie. - `filename` (string, required) — Le nom de fichier de la partie. - `hash` (string, required) — L'empreinte cryptographique de la partie. - `size` (long, required) — La taille de la partie. - `isOriginal` (boolean, optional) — Indique si la partie est une partie originale ou modifiée. - `policyUri` (string, optional) — L'URL d'accès au PDF de la politique de signature. Sans valeur spécifiée, l'URL de la politique de signature par défaut est appliquée. - `visualIdentification` (string, optional) — L'identification visuelle appliquée à la partie. - `tenantId` (string, required) — L'identifiant du tenant auquel appartient le document. - `updated` (long, required) — La date de dernière modification de l'entité. - `userId` (string, required) — L'identifiant de l'utilisateur auquel appartient le document. - `viewAuthorizedGroups` (list of string, required) — La liste des identifiants de groupes dont les membres peuvent consulter le parapheur auquel appartient le document. - `viewAuthorizedUsers` (list of string, required) — La liste des identifiants d'utilisateurs autorisés à consulter le parapheur auquel appartient le document. - `workflowId` (string, required) — L'identifiant du parapheur auquel appartient le document. - `workflowName` (string, required) — Le nom du parapheur auquel appartient le document. - `confidentiality` (boolean, optional) — Le statut de confidentialité des pièces jointes. - `orderIndex` (long, optional) — L'index d'ordre permet de personnaliser l'ordre d'affichage des documents. - `pdfSignatureFields` (list of object, optional) — Pour un document PDF, la liste des champs de signature que les signataires devront remplir. - `imageHeight` (double, optional) — La hauteur (en pixels) de l'image de signature dans la page PDF. Ignoré si fieldId est défini. - `imagePage` (long, optional) — La page du PDF où l'image de signature apparaît, à partir de 1. Une valeur négative compte depuis la dernière page. Ignoré si fieldId est défini. - `imageWidth` (double, optional) — La largeur (en pixels) de l'image de signature dans la page PDF. Ignoré si fieldId est défini. - `imageX` (double, optional) — La position (en pixels) de l'image de signature dans la page PDF (axe X). Ignoré si fieldId est défini. - `imageY` (double, optional) — La position (en pixels) de l'image de signature dans la page PDF (axe Y). Ignoré si fieldId est défini. - `fieldId` (string, optional) — L'identifiant du champ de signature existant dans le document PDF. - `signatureProfileId` (string, optional) — Le profil de signature utilisé pour signer le document. S'il est absent, le document est une pièce jointe. - `subOrderIndex` (long, optional) — L'index de sous-ordre permet de personnaliser l'ordre d'affichage des documents dans les dossiers. - `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. ## Errors ### 400 Bad Request Error InvalidPdfSignatureField : Les paramètres d'un champ de signature PDF sont incorrects. ; PdfSignatureFieldOutsideDocument : Un champ de signature est placé en dehors d'une page du document. ; PdfSignatureFieldsOverlap : Des champs de signature se chevauchent. ; TemplateMaxAttachmentsReached : Le nombre maximal de pièces jointes du modèle est atteint. ; TemplateMaxDocumentsReached : Le nombre maximal de documents à signer du modèle est atteint. ; TenantMaxAttachmentsReached : Le nombre maximal de pièces jointes est atteint. ; TenantMaxDocumentsReached : Le nombre maximal de documents à signer est atteint. - `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. ### 403 Forbidden Error AuthenticatedUserDisabled : L'utilisateur authentifié est désactivé. ; MissingBearerToken : Un jeton Bearer est requis. ; SignatureProfileDisabled : Le profil de signature spécifié est désactivé. ; SignatureProfileNotAllowed : Le profil de signature spécifié n'est pas autorisé pour ce document. ; TemplateAttachmentsNotAllowed : Les pièces jointes ne sont pas autorisées par le modèle. ; TenantAttachmentsNotAllowed : Les pièces jointes ne sont pas autorisées par le tenant. ; 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. ### 404 Not Found Error SignatureProfileNotFound : Le profil de signature spécifié est introuvable. ; WorkflowDocumentNotFound : Le document de parapheur spécifié est introuvable. - `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. ### 409 Conflict Error EntityLocked : L'entité est en cours de mise à jour. - `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. ### 412 Precondition Failed Error ConditionalUpdateFailed : Une condition de la requête de mise à jour n'est pas satisfaite. - `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 { "signatureProfileId": "sip_CSRi6rm3B6QaZ8KKH8v9tcr5", "pdfSignatureFields": [ { "imagePage": -1, "imageX": 390, "imageY": 710, "imageWidth": 150, "imageHeight": 80 } ], "confidentiality": false, "orderIndex": 10, "subOrderIndex": 5 } ``` **Response** ```json { "created": 1782821377330, "displayedParts": [ { "contentType": "application/pdf", "filename": "Document", "hash": "O3DoQCYo2l443ulByo4hwGuxzCZwiW0Vr7K9j56AYuM=", "size": 18667, "isOriginal": true, "policyUri": "https://sites.banque-france.fr/igc/signature/ps/ps_1_2_250_1_115_200_300_4.pdf" } ], "groupId": "grp_BTsBTqgZuePSmmPz5ynWM2nN", "id": "doc_ABZhKrpUbf4BCyWCkM1mRyqP", "parts": [ { "contentType": "application/pdf", "filename": "Document", "hash": "O3DoQCYo2l443ulByo4hwGuxzCZwiW0Vr7K9j56AYuM=", "size": 18667, "isOriginal": true, "policyUri": "https://sites.banque-france.fr/igc/signature/ps/ps_1_2_250_1_115_200_300_4.pdf" } ], "tenantId": "ten_Hm5gqY6oKADYdg9cjhsVbQDH", "updated": 1782821377384, "userId": "usr_JCwoLDH99mzqizvqyAYJx4gV", "viewAuthorizedGroups": [ "grp_BTsBTqgZuePSmmPz5ynWM2nN", "grp_ExUUECizVJs8KVq7nCwhwMR1" ], "viewAuthorizedUsers": [ "usr_4jreEenog6oRuAo74sW6RS3z" ], "workflowId": "wfl_Ed1PfdvZJC9PMT3s4MZy4Pko", "workflowName": "Heavy Duty Wooden Pants", "confidentiality": false, "orderIndex": 2, "pdfSignatureFields": [ { "imageHeight": 80, "imagePage": -1, "imageWidth": 150, "imageX": 390, "imageY": 710 } ], "signatureProfileId": "sip_CSRi6rm3B6QaZ8KKH8v9tcr5", "subOrderIndex": 5 } ``` **SDK Code** ```python Requête réussie. import requests url = "https://workflow-manager/api/documents/documentId" payload = { "signatureProfileId": "sip_CSRi6rm3B6QaZ8KKH8v9tcr5", "pdfSignatureFields": [ { "imagePage": -1, "imageX": 390, "imageY": 710, "imageWidth": 150, "imageHeight": 80 } ], "confidentiality": False, "orderIndex": 10, "subOrderIndex": 5 } headers = { "If-Match": "If-Match", "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.patch(url, json=payload, headers=headers) print(response.json()) ``` ```javascript Requête réussie. const url = 'https://workflow-manager/api/documents/documentId'; const options = { method: 'PATCH', headers: { 'If-Match': 'If-Match', Authorization: 'Bearer ', 'Content-Type': 'application/json' }, body: '{"signatureProfileId":"sip_CSRi6rm3B6QaZ8KKH8v9tcr5","pdfSignatureFields":[{"imagePage":-1,"imageX":390,"imageY":710,"imageWidth":150,"imageHeight":80}],"confidentiality":false,"orderIndex":10,"subOrderIndex":5}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Requête réussie. package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://workflow-manager/api/documents/documentId" payload := strings.NewReader("{\n \"signatureProfileId\": \"sip_CSRi6rm3B6QaZ8KKH8v9tcr5\",\n \"pdfSignatureFields\": [\n {\n \"imagePage\": -1,\n \"imageX\": 390,\n \"imageY\": 710,\n \"imageWidth\": 150,\n \"imageHeight\": 80\n }\n ],\n \"confidentiality\": false,\n \"orderIndex\": 10,\n \"subOrderIndex\": 5\n}") req, _ := http.NewRequest("PATCH", url, payload) req.Header.Add("If-Match", "If-Match") 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 Requête réussie. require 'uri' require 'net/http' url = URI("https://workflow-manager/api/documents/documentId") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Patch.new(url) request["If-Match"] = 'If-Match' request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"signatureProfileId\": \"sip_CSRi6rm3B6QaZ8KKH8v9tcr5\",\n \"pdfSignatureFields\": [\n {\n \"imagePage\": -1,\n \"imageX\": 390,\n \"imageY\": 710,\n \"imageWidth\": 150,\n \"imageHeight\": 80\n }\n ],\n \"confidentiality\": false,\n \"orderIndex\": 10,\n \"subOrderIndex\": 5\n}" response = http.request(request) puts response.read_body ``` ```java Requête réussie. import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.patch("https://workflow-manager/api/documents/documentId") .header("If-Match", "If-Match") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"signatureProfileId\": \"sip_CSRi6rm3B6QaZ8KKH8v9tcr5\",\n \"pdfSignatureFields\": [\n {\n \"imagePage\": -1,\n \"imageX\": 390,\n \"imageY\": 710,\n \"imageWidth\": 150,\n \"imageHeight\": 80\n }\n ],\n \"confidentiality\": false,\n \"orderIndex\": 10,\n \"subOrderIndex\": 5\n}") .asString(); ``` ```php Requête réussie. request('PATCH', 'https://workflow-manager/api/documents/documentId', [ 'body' => '{ "signatureProfileId": "sip_CSRi6rm3B6QaZ8KKH8v9tcr5", "pdfSignatureFields": [ { "imagePage": -1, "imageX": 390, "imageY": 710, "imageWidth": 150, "imageHeight": 80 } ], "confidentiality": false, "orderIndex": 10, "subOrderIndex": 5 }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', 'If-Match' => 'If-Match', ], ]); echo $response->getBody(); ``` ```csharp Requête réussie. using RestSharp; var client = new RestClient("https://workflow-manager/api/documents/documentId"); var request = new RestRequest(Method.PATCH); request.AddHeader("If-Match", "If-Match"); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"signatureProfileId\": \"sip_CSRi6rm3B6QaZ8KKH8v9tcr5\",\n \"pdfSignatureFields\": [\n {\n \"imagePage\": -1,\n \"imageX\": 390,\n \"imageY\": 710,\n \"imageWidth\": 150,\n \"imageHeight\": 80\n }\n ],\n \"confidentiality\": false,\n \"orderIndex\": 10,\n \"subOrderIndex\": 5\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift Requête réussie. import Foundation let headers = [ "If-Match": "If-Match", "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "signatureProfileId": "sip_CSRi6rm3B6QaZ8KKH8v9tcr5", "pdfSignatureFields": [ [ "imagePage": -1, "imageX": 390, "imageY": 710, "imageWidth": 150, "imageHeight": 80 ] ], "confidentiality": false, "orderIndex": 10, "subOrderIndex": 5 ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://workflow-manager/api/documents/documentId")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "PATCH" 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() ```