Add workflow fields
===================

Adding fields to a document can be a difficult task.
The positions must be calculated for all fields and it depends on many parameters.
We provide a designer to make this process easier.

.. image:: /_images/designer.png
   :alt: YumiSign Designer

+--------+-----------------------------------------------------------------+
| Method | Path                                                            |
+========+=================================================================+
| GET    | /api/v1/workspaces/{workspaceId}/workflows/{workflowId}/session |
+--------+-----------------------------------------------------------------+

.. warning::

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

.. tip::

    Embed the designerUrl provided in the response on your website
    and keep your client on your site during all the workflow creation process.

Example
"""""""

.. code-block:: bash

    curl --request GET 'https://app.yumisign.com/api/v1/workspaces/1/workflows/1/session'

.. code-block:: json

    {
        "session": "custom_session_id",
        "designerUrl": "https://app.yumisign.com/app/designer/custom_session_id"
    }