Create Workflow from template

Method	Path
POST	/api/v1/cloner/template/{templateId}/workflow

Parameters

• workspaceId int | required

The workspace id where the new workflow will be placed.

• name string | required

The workflow name.

• recipients array | required

The list of recipients for your workflow. It must contain the number of recipients the template is waiting for.

• recipients[0].name string | required

The recipient name.

• recipients[0].email string | required

The recipient email address.

• hasToBeStarted bool | optional

The boolean that will define if you want start the workflow just after creating it, default value false.

Example

curl --request POST 'https://app.yumisign.com/api/v1/cloner/template/{templateId}/workflow' \
    --header 'Content-Type: application/json' \
    --data-raw '{
        "workspaceId": 1,
        "name": "workflow from template",
        "recipients": [
            {
                "name": "Recipient name",
                "email": "email@mail.com"
            }
        ],
        "hasToBeStarted": true
    }'

{
   "envelopeId":"20221019b20b088e26f9e1e50035db490880c45a",
   "status":"started",
   "oldStatus":null,
   "startDate":null,
   "scheduledStartDate":null,
   "createDate":1666166951,
   "expiryDate":1673942951,
   "documents":[
      {
         "id":7047,
         "file":{
            "file":"Document Url",
            "thumb":"Url",
            "format":"pdf",
            "size":124157,
            "name":"fileName.pdf"
         },
         "position":1
      }
   ],
   "creator":{
      "email":"email@mail.com",
      "picture":{
         "file": null,
         "thumb": null,
         "format":" ",
         "size":0
      },
      "name":"First Name",
      "country":"FR",
      "id":5
   },
   "steps":[
      {
         "order":1,
         "type":"sign",
         "expiryDate":null,
         "actions":[
            {
               "status":"started",
               "recipientId":8545,
               "transaction":null,
               "recipientEmail":"email@mail.com",
               "role":8655,
               "type":"sign",
               "comment":null,
               "stepNumber":1,
               "id":8751
            }
         ],
         "status":"started",
         "id":7601
      }
   ],
   "recipients":[
      {
         "picture":null,
         "roles":[
            {
               "type":"sign",
               "color":"#3a0687",
               "id":8655
            }
         ],
         "email":"email@mail.com",
         "id":8545,
         "name":"Recipient name"
      }
   ],
   "fields":[
      {
         "type":"signature",
         "label":"Signature",
         "documentId":7047,
         "page":1,
         "value":null,
         "posY":31.39,
         "posX":39.83,
         "role":8655,
         "style":{
            "color":"#000000",
            "fontStyle":"monospace, courier",
            "fontSize":11,
            "width":19.83,
            "height":7.02,
            "bold":false,
            "italic":false,
            "underline":false
         },
         "id":28793
      }
   ],
   "type":"simple",
   "senderMessage":null,
   "signingSecurity":"none",
   "senderName":null,
   "organization":{
      "id":5,
      "name":"Organization Name"
   },
   "tags":[

   ],
   "metadata":[

   ],
   "id":7045,
   "name":"Workflow Name"
}