Qodex.ai

/procedures

POST {{base-api-url}}/procedures

To order the participants, it's necessary to define 2 elements on procedure:

  • The ordered parameter with true value.
    • This boolean will enable the feature because the default value is false.
    • This boolean is located at the first level of resources.
  • The position parameter for each participant.
    • Value 1 will define the first participant of the workflow, 2 the second one, and so on.
    • This value is located on member resource.

Request Body

{"name"=>"My first ordered procedure", "description"=>"Sample with ordered workflow for participants", "start"=>true, "ordered"=>true, "members"=>[{"position"=>1, "firstname"=>"John", "lastname"=>"Doe", "email"=>"john.doe@yousign.fr", "phone"=>"+33612345678", "fileObjects"=>[{"position"=>"183,511,285,591", "page"=>2, "file"=>"/files/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"}]}, {"position"=>2, "firstname"=>"Marcus", "lastname"=>"Miller", "email"=>"marcus.miller@yousign.fr", "phone"=>"+33687654321", "fileObjects"=>[{"position"=>"387,511,489,591", "page"=>2, "file"=>"/files/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"}]}]}

HEADERS

KeyDatatypeRequiredDescription
AuthorizationstringThis value is a secret and needs to be replaced by your API Key (Bearer).
Content-TypestringThis header specifies the format of the exchanges in JSON.

RESPONSES

status: Created

{"id":"/procedures/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","name":"My first ordered procedure","description":"Sample with ordered workflow for participants","createdAt":"2018-12-02T12:35:34+01:00","updatedAt":"2018-12-02T12:35:34+01:00","finishedAt":null,"expiresAt":null,"status":"active","creator":null,"creatorFirstName":null,"creatorLastName":null,"workspace":"/workspaces/XXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","template":false,"ordered":true,"parent":null,"metadata":[],"config":[],"members":[{"id":"/members/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","user":null,"type":"signer","firstname":"John","lastname":"Doe","email":"john.doe@yousign.fr","phone":"+33612345678","position":1,"createdAt":"2018-12-02T12:35:34+01:00","updatedAt":"2018-12-02T12:35:34+01:00","finishedAt":null,"status":"pending","fileObjects":[{"id":"/file_objects/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","file":{"id":"/files/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","name":"The best name for my file.pdf","type":"signable","contentType":"application/pdf","description":null,"createdAt":"2018-12-02T12:34:59+01:00","updatedAt":"2018-12-02T12:35:34+01:00","sha256":"bb57ae2b2ca6ad0133a699350d1a6f6c8cdfde3cf872cf526585d306e4675cc2","metadata":[],"workspace":"/workspaces/XXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","creator":null,"protected":false,"position":0,"parent":null},"page":2,"position":"183,511,285,591","fieldName":null,"mention":null,"mention2":null,"createdAt":"2018-12-02T12:35:34+01:00","updatedAt":"2018-12-02T12:35:34+01:00","parent":null,"reason":"Signed by Yousign"}],"comment":null,"notificationsEmail":[],"operationLevel":"custom","operationCustomModes":["sms"],"operationModeSmsConfig":null,"parent":null},{"id":"/members/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","user":null,"type":"signer","firstname":"Marcus","lastname":"Miller","email":"marcus.miller@yousign.fr","phone":"+33687654321","position":2,"createdAt":"2018-12-02T12:35:34+01:00","updatedAt":"2018-12-02T12:35:34+01:00","finishedAt":null,"status":"pending","fileObjects":[{"id":"/file_objects/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","file":{"id":"/files/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","name":"The best name for my file.pdf","type":"signable","contentType":"application/pdf","description":null,"createdAt":"2018-12-02T12:34:59+01:00","updatedAt":"2018-12-02T12:35:34+01:00","sha256":"bb57ae2b2ca6ad0133a699350d1a6f6c8cdfde3cf872cf526585d306e4675cc2","metadata":[],"workspace":"/workspaces/XXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","creator":null,"protected":false,"position":0,"parent":null},"page":2,"position":"387,511,489,591","fieldName":null,"mention":null,"mention2":null,"createdAt":"2018-12-02T12:35:34+01:00","updatedAt":"2018-12-02T12:35:34+01:00","parent":null}],"comment":null,"notificationsEmail":[],"operationLevel":"custom","operationCustomModes":["sms"],"operationModeSmsConfig":null,"parent":null}],"subscribers":[],"files":[{"id":"/files/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","name":"The best name for my file.pdf","type":"signable","contentType":"application/pdf","description":null,"createdAt":"2018-12-02T12:34:59+01:00","updatedAt":"2018-12-02T12:35:34+01:00","sha256":"bb57ae2b2ca6ad0133a699350d1a6f6c8cdfde3cf872cf526585d306e4675cc2","metadata":[],"workspace":"/workspaces/XXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","creator":null,"protected":false,"position":0,"parent":null}],"relatedFilesEnable":false,"archive":false,"archiveMetadata":[],"fields":[],"permissions":[]}