Create a workflow

Method	Path
POST	/api/v1/workspaces/{workspaceId}/workflows

Warning

Create a workflow using /api/v1/workflows is deprecated. You need to pass the workspace id on the path to ensure the workflow is attached to the good workspace.

Parameters

• name string | required

The name of your workflow. It must be at least 2 characters long.

• document binary | required

A document for your workflow. It must be a pdf file with a max size of 20M.

• type enum | optional

Value	Description
simple	Sign on web or with you mobile (default)
advanced	Advanced workflow
qualified	Qualified workflow

• expiryDate int | optional

A timestamp of the expiry date of your workflow. It must be between now +7 days and now +90 days. Default now +7days.

Example

curl --request POST 'https://app.yumisign.com/api/v1/workspaces/1/workflows' \
    --form 'name="Workflow name"' \
    --form 'document=@"/path/to/my/document.pdf"' \
    --form 'type="simple"' \
    --form 'expiryDate="1609977600"'

{
    "id": 1,
    "envelopeId": "20220525685b0ee0a41aa041aeefedc26ae3a971",
    "documents": [
        {
            "id": 1,
            "position": 1,
            "file": {
                "name": "document.pdf"
                "format": "pdf",
                "size": 104414,
                "file": "https://app.yumisign.com/api/v1/storage/temp/1/doc/614436f59c9acecc05aa4b98416707f1",
                "thumb": "https://app.yumisign.com/api/v1/storage/temp/1/doc/614436f565db844c7b6f5a53befbcd80"
            }
        }
    ]
}