> 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. # Créer un champ dynamique POST https://workflow-manager/api/workflows/{workflowId}/dynamicFields Content-Type: application/json Ajoute un champ dynamique. `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/dynamic-fields/create-a-dynamic-field ## 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. ### Body (application/json) This endpoint expects an object. - `name` (string, required) — Le nom du champ dynamique. - `description` (string, optional) — La description du champ dynamique. ## Response ### 200 Créer un champ dynamique - `created` (long, required) — La date de création de l'entité. - `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. - `email` (string, required) — L'adresse email de l'utilisateur propriétaire du parapheur. - `firstName` (string, required) — Le prénom de l'utilisateur propriétaire du parapheur. - `groupId` (string, required) — L'identifiant du groupe auquel appartient le parapheur. - `id` (string, required) — L'identifiant du parapheur. - `lastName` (string, required) — Le nom de l'utilisateur propriétaire du parapheur. - `logs` (list of any, required) — Les journaux du parapheur. - `name` (string, required) — Le nom du parapheur. - `notifiedEvents` (list of string, required) — Les types d'événements pour lesquels le propriétaire reçoit des notifications. - `pictureResourceId` (string, required) — L'identifiant de la ressource photo de l'utilisateur propriétaire du parapheur. - `progress` (long, required) — L'avancement du parapheur. - `steps` (list of object, required) — Les étapes du parapheur. - `allowComments` (boolean, required) — Indique si les destinataires de l'étape sont autorisés à consulter et créer des commentaires. - `hideAttachments` (boolean, required) — Indique si les pièces jointes sont affichées aux destinataires de l'étape. - `hideWorkflowRecipients` (boolean, required) — Indique si les autres destinataires du parapheur sont visibles par les destinataires de cette étape. - `id` (string, required) — L'identifiant de l'étape. - `invitePeriod` (long, required) — Le délai après lequel les invitations sont renvoyées. - `isFinished` (boolean, required) — Indique si l'étape est démarrée. - `isStarted` (boolean, required) — Indique si l'étape est démarrée. - `logs` (list of any, required) — Les journaux de l'étape. - `maxInvites` (long, required) — Le nombre maximal d'invitations envoyées aux destinataires. La valeur 0 signifie que le destinataire n'est jamais invité. - `recipients` (list of object, required) — La liste des destinataires appelés à signer ou valider les documents. - `consentPageId` (string, required) — L'identifiant de la page de consentement à utiliser pour la requête. - `country` (string, required) — Le pays de l'utilisateur. - `email` (string, required) — L'adresse email du destinataire. - `firstName` (string, required) — Le prénom du destinataire. - `lastName` (string, required) — Le nom du destinataire. - `comments` (string, optional) — Les commentaires associés au contact. - `organizationId` (string, optional) — L'identifiant de l'organisation pour le compte de laquelle la signature est apposée. - `phoneNumber` (string, optional) — Le numéro de téléphone international du destinataire. - `pictureResourceId` (string, optional) — L'identifiant de la ressource photo de l'utilisateur, lorsque le destinataire est un utilisateur. - `preferredLocale` (string, optional) — La locale préférée pour les emails de notification envoyés au destinataire. - `userId` (string, optional) — L'identifiant de l'utilisateur destinataire, lorsque le destinataire est un utilisateur. - `requiredRecipients` (long, required) — Le nombre de destinataires devant signer ou valider les documents pour que l'étape se termine. - `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. - `stepType` (enum, required) — Le type de l'étape : signature ou approval. - Allowed values: `approval`, `signature` - `validityPeriod` (long, required) — La durée de validité de l'étape. - `viewConfidentialAttachments` (boolean, required) — Indique si les pièces jointes confidentielles sont affichées aux destinataires de l'étape. - `disableMandatoryViewing` (boolean, optional) — Indique si la consultation obligatoire des documents est désactivée pour cette étape. - `faceToFaceSignature` (boolean, optional) — Indique si l'étape utilise le mode de signature en face-à-face. - `requireSupportingDocuments` (boolean, optional) — Indique si le dépôt de pièces justificatives est requis pour cette étape. - `supportingDocumentIds` (list of any, optional) — La liste des identifiants des pièces justificatives liées à cette étape. - `supportingDocuments` (list of any, optional) — La liste des pièces justificatives liées à cette étape. - `supportingDocumentsList` (string, optional) — La liste des pièces justificatives que le signataire doit fournir (5 au maximum). Requis uniquement si requireSupportingDocuments vaut true. - `tenantId` (string, required) — L'identifiant du tenant auquel appartient le parapheur. - `updated` (long, required) — La date de dernière modification de l'entité. - `userId` (string, required) — L'identifiant de l'utilisateur auquel appartient le parapheur. - `viewAuthorizedGroups` (list of string, required) — La liste des identifiants de groupes dont les membres peuvent consulter ce parapheur. - `viewAuthorizedUsers` (list of string, required) — La liste des identifiants d'utilisateurs autorisés à consulter ce parapheur. - `watchers` (list of object, required) — La liste des utilisateurs autorisés à voir le parapheur et notifiés de ses événements. - `notifiedEvents` (list of string, required) — Les types d'événements pour lesquels l'observateur reçoit des notifications. - `email` (string, optional) — L'adresse email de l'observateur, lorsqu'il n'est pas un utilisateur. - `userId` (string, optional) — L'identifiant de l'utilisateur, lorsque l'observateur est un utilisateur. - `workflowMode` (enum, required) — Le mode du parapheur. - Allowed values: `FULL`, `SINGLE_SIGNER` - `workflowStatus` (enum, required) — Le statut du parapheur. - Allowed values: `draft`, `started`, `stopped`, `finished`, `archived` - `allowConsolidation` (boolean, optional) — Indique si la consolidation du parapheur est activée. - `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. - `description` (string, optional) — La description du parapheur. - `dynamicFields` (list of object, optional) — Liste des champs dynamiques. - `id` (string, required) — Identifiant du champ dynamique. - `name` (string, required) — Nom du champ dynamique. - `order` (long, required) — Ordre du champ dynamique. - `type` (enum, required) — Type du champ dynamique. Valeurs possibles : TEXT. - Allowed values: `TEXT` - `description` (string, optional) — Description du champ dynamique. - `value` (string, optional) — Value of the dynamic field. - `instances` (list of object, optional) — Instances des champs dynamiques. - `id` (string, required) — Identifiants des instances du champ dynamique. - `documentId` (string, required) — Identifiant du document auquel les instances du champ dynamique s'appliquent. - `documentPage` (integer, required) — Page du document à laquelle les instances du champ dynamique s'appliquent. - `posX` (integer, required) — Position sur l'axe X appliquée aux instances du champ dynamique. - `posY` (integer, required) — Position sur l'axe Y appliquée aux instances du champ dynamique. - `font` (string, required) — Police appliquée aux instances du champ dynamique. - `color` (string, required) — Couleur appliquée aux instances du champ dynamique. - `size` (integer, required) — Taille de police appliquée aux instances du champ dynamique. - `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. - `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. - `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é. ; InvalidWorkflowStatus : Le statut du parapheur ne permet pas cette opération. ; MissingBearerToken : Un jeton Bearer est requis. ; 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 { "name": "test2", "description": "this is an other description" } ``` **Response** ```json { "created": 1782821624864, "currentRecipientEmails": [], "currentRecipientUsers": [], "email": "bobby.schulist3960@my-company.com", "firstName": "Thomas", "groupId": "grp_BTsBTqgZuePSmmPz5ynWM2nN", "id": "wfl_2xm2NZ8k1P41dFewbxSudxXz", "lastName": "Graham", "logs": [], "name": "Awesome Wooden Gloves", "notifiedEvents": [ "recipientRefused", "recipientFinished", "workflowStopped", "workflowFinished" ], "pictureResourceId": "res_Nct5FtPxv8E5u18sePwFXNpP", "progress": 0, "steps": [ { "allowComments": true, "hideAttachments": false, "hideWorkflowRecipients": false, "id": "stp_AP3iNsa3nupKNRNX2f4msWBh", "invitePeriod": 86400000, "isFinished": false, "isStarted": false, "logs": [], "maxInvites": 5, "recipients": [ { "consentPageId": "cop_AfGTsGSh1mmatSUL5AWFo2Do", "country": "FR", "email": "keeley.brown2482@my-company.com", "firstName": "Kent", "lastName": "Barton", "comments": "Aliquam et numquam voluptatem enim est illo.", "organizationId": "org_i3niMbz4WCYkMgYe9y7KnHgv", "phoneNumber": "+33 6 12 34 56 78", "pictureResourceId": "res_4Z7qYs9LrDsZ5v293CLMGJYb", "preferredLocale": "fr", "userId": "usr_KG8yTeqRa1kskaSp7Y7GRPAB" } ], "requiredRecipients": 1, "sendDownloadLink": true, "stepType": "signature", "validityPeriod": 8553600000, "viewConfidentialAttachments": true, "disableMandatoryViewing": false, "faceToFaceSignature": false, "requireSupportingDocuments": false, "supportingDocumentIds": [], "supportingDocuments": [] } ], "tenantId": "ten_Hm5gqY6oKADYdg9cjhsVbQDH", "updated": 1782821625034, "userId": "usr_JCwoLDH99mzqizvqyAYJx4gV", "viewAuthorizedGroups": [ "grp_BTsBTqgZuePSmmPz5ynWM2nN", "grp_ExUUECizVJs8KVq7nCwhwMR1" ], "viewAuthorizedUsers": [ "usr_KySV8xSBw1M2vbe2YcN4gAUB" ], "watchers": [ { "notifiedEvents": [ "recipientRefused", "recipientFinished", "workflowStarted", "workflowStopped", "workflowFinished", "workflowFinishedDownloadLink", "workflowFinishedDownloadLinkNoAttachment" ], "email": "merle.bradtke5468@my-company.com" }, { "notifiedEvents": [ "recipientRefused", "recipientFinished", "workflowStarted", "workflowStopped", "workflowFinished", "workflowFinishedDownloadLink", "workflowFinishedDownloadLinkNoAttachment" ], "userId": "usr_KySV8xSBw1M2vbe2YcN4gAUB" } ], "workflowMode": "FULL", "workflowStatus": "draft", "allowConsolidation": true, "allowedCoManagerUsers": [], "coManagerNotifiedEvents": [], "description": "3 Allée, Voie des Grands Augustins, 56331 Ivry-sur-Seine", "dynamicFields": [ { "id": "dyc_2UZJRuMww2uJ1cHAjbziT8v2", "name": "test", "order": 1, "type": "TEXT", "description": "this is a description" }, { "id": "dyc_4cGLC2AUzQja3GWGjdZbiUpL", "name": "test2", "order": 2, "type": "TEXT", "description": "this is an other description" } ] } ``` **SDK Code** ```python Requête réussie. import requests url = "https://workflow-manager/api/workflows/workflowId/dynamicFields" payload = { "name": "test2", "description": "this is an other description" } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript Requête réussie. const url = 'https://workflow-manager/api/workflows/workflowId/dynamicFields'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"name":"test2","description":"this is an other description"}' }; 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/workflows/workflowId/dynamicFields" payload := strings.NewReader("{\n \"name\": \"test2\",\n \"description\": \"this is an other description\"\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 Requête réussie. require 'uri' require 'net/http' url = URI("https://workflow-manager/api/workflows/workflowId/dynamicFields") 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 \"name\": \"test2\",\n \"description\": \"this is an other description\"\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.post("https://workflow-manager/api/workflows/workflowId/dynamicFields") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"name\": \"test2\",\n \"description\": \"this is an other description\"\n}") .asString(); ``` ```php Requête réussie. request('POST', 'https://workflow-manager/api/workflows/workflowId/dynamicFields', [ 'body' => '{ "name": "test2", "description": "this is an other description" }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp Requête réussie. using RestSharp; var client = new RestClient("https://workflow-manager/api/workflows/workflowId/dynamicFields"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"name\": \"test2\",\n \"description\": \"this is an other description\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift Requête réussie. import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "name": "test2", "description": "this is an other description" ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://workflow-manager/api/workflows/workflowId/dynamicFields")! 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() ```