Add workflow steps

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

Warning

Add workflow steps using /api/v1/workflows/{id}/steps is deprecated. You need to pass the workspace id on the path.

Parameters

• steps array | required

The list of steps for your workflow. It must contain at least one item.

• steps[0].sign boolean | required

A boolean determinating if a step is sign or review.

• steps[0].roles array | required

An array of role ids for your step.

Example

curl --request POST 'https://app.yumisign.com/api/v1/workspaces/1/workflows/1/steps' \
    --header 'Content-Type: application/json' \
    --data-raw '{
        "steps": [
            {
                "sign": true,
                "roles": [1]
            }
        ]
    }'

[
    {
        "id": 1,
        "order": 1,
        "type": "sign",
        "status": "not_started",
        "expiryDate": null,
        "actions": [
            {
                "id": 1,
                "stepNumber": 1,
                "role": 1,
                "type": "sign",
                "status": "not_started",
                "recipientId": 1,
                "recipientEmail": "jane.doe@example.com",
                "comment": null
            }
        ]
    }
]