/procedures
POST {{base-api-url}}/procedures
Starting a procedure means that you will trigger the start of the signing process for the different stakeholders. Consequently, the procedure will start and you won't be able to edit it anymore.
In addition, the default value is true and all the other values, except false, will also start the procedure.
Finally, it is also possible to activate archiving service directly on your procedures if your subscription and plan allow it. For more information about archiving you can consult the dedicated section.
Request Body
{"name"=>"My procedure", "description"=>"Description of my procedure with advanced mode", "metadata"=>{"procedure-key1"=>"procedure-value1"}, "start"=>false, "archive"=>true, "archiveMetadata"=>{"archive-key1"=>"archive-key1"}}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string | This value is a secret and needs to be replaced by your API Key (Bearer). | |
Content-Type | string | This header specifies the format of the exchanges in JSON. |
RESPONSES
status: Created
{"id":"/procedures/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","name":"My procedure","description":"Description of my procedure with advanced mode","createdAt":"2018-12-01T13:41:43+01:00","updatedAt":"2018-12-01T13:41:43+01:00","finishedAt":null,"expiresAt":null,"status":"draft","creator":null,"creatorFirstName":null,"creatorLastName":null,"workspace":"/workspaces/XXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","template":false,"ordered":false,"parent":null,"metadata":{"procedure-key1":"procedure-value1"},"config":[],"members":[],"subscribers":[],"files":[],"relatedFilesEnable":false,"archive":true,"archiveMetadata":{"archive-key1":"archive-key1"},"fields":[],"permissions":[]}