Create a quick workflow
=======================

To create a quick workflow you just need to send a document
and your steps configuration with or without preferences.

* A workflow with your document is created
* Recipients are added to the workflow
* Steps are created and added to the workflow
* Fields are added to the document
* Workflow is started and recipients are notified to sign or review the document (an invitation is sent if the recipient does not have a account)

+--------+-------------------------+
| Method | Path                    |
+========+=========================+
| POST   | /api/v1/quick/envelopes |
+--------+-------------------------+

.. note::

    This request needs to be performed using form data to send the document.

Parameters
----------

* ``name`` string | required

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

* ``document`` binary | required

The document of 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.

* ``steps`` array | required

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

* ``steps[0].type`` enum | required

+--------+-------------+
| Value  | Description |
+========+=============+
| sign   | Sign step   |
+--------+-------------+
| review | Review step |
+--------+-------------+

* ``steps[0].recipients`` array | required

An array of recipients for your step.

* ``steps[0].recipients[0].name`` string | required

The recipient name.

* ``steps[0].recipients[0].email`` string | required

The recipient email address.

* ``preferences`` array | optional

The list of preferences for your workflow.

* ``preferences[0].name`` string | required

The preference name.

* ``preferences[0].value`` string | required

The preference value.

Steps
-----

You can add one step or more, depending on how you want to structure your workflow.

.. note::

    The step types determinate the role of their recipients.

Preferences
-----------

You can attach multiple optional preferences.

.. include:: ../shared/preferences-table.rst.inc

Example
"""""""

.. code-block:: bash

    curl --request POST 'https://app.yumisign.com/api/v1/quick/envelopes' \
        --form 'name="Workflow name"' \
        --form 'document=@"/path/to/my/document.pdf"' \
        --form 'type="simple"' \
        --form 'expiryDate="1632819924"' \
        --form 'steps[0][type]="sign"' \
        --form 'steps[0][recipients][0][name]="Recipient name"' \
        --form 'steps[0][recipients][0][email]="recipient@email.com"' \
        --form 'preferences[0][name]="WorkflowMailAttachDocumentPreference"' \
        --form 'preferences[0][value]="0"' \
        --form 'preferences[1][name]="WorkflowNotificationCallbackUrlPreference"' \
        --form 'preferences[1][value]="http://my-site/webhooks/yumisign"'
        --form 'preferences[2][name]="WorkflowNotificationCallbackUrlSslVerificationPreference"' \
        --form 'preferences[2][value]="1"'
        --form 'preferences[3][name]="WorkflowNotificationCallbackUrlSecretPreference"' \
        --form 'preferences[3][value]="9fba5d973977f17f3ae76bc059a3c8a3"'

.. code-block:: json

    {
        "id": "20211123aba6531f586827ef412d5f9e729f572e"
    }