Update a workflow

Method	Path
PUT	/api/v1/workspaces/{workspaceId}/workflows/{workflowId}

Warning

Update a workflow using /api/v1/workspaces/{workspaceId}/workflows/{workflowId}/edit with method POST is deprecated. You need to switch to method PUT without including the document in request data. If you want to update the document, you need to use this endpoint.

Parameters

• name string | optional

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

• 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.

• newWorkspaceId int | optional

The id of the workspace you want the workflow to be moved to.

• senderMessage string | optional

A message added to the signature request email.

• metadata array | optional

Set of key-value pairs that you can attach to the object. This can be useful for storing additional information about the object in a structured format. You can specify up to 10 keys, with key names as string up to 40 characters long and values up to 250 characters long. All keys can be unset by posting an empty array.

Example

curl --request PUT 'https://app.yumisign.com/api/v1/workspaces/1/workflows/1' \
    --header 'Content-Type: application/json' \
    --data-raw '{
        "name": "Workflow name"
        "type": "simple",
        "expiryDate": "1609977600",
        "newWorkspaceId": 2,
        "senderMessage": "Please sign this document",
        "metadata": {
            "my_id": 1
        }
    }'

{
    "id": 1,
    "status":"not_started",
    "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"
            }
        }
    ]
}