Add workflow preferences
========================

+--------+---------------------------------------------------------------------+
| Method | Path                                                                |
+========+=====================================================================+
| POST   | /api/v1/workspaces/{workspaceId}/workflows/{workflowId}/preferences |
+--------+---------------------------------------------------------------------+

Parameters
----------

* ``preferences`` array | required

The list of preferences for your workflow.

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

The preference name.

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

The preference value.

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

You can attach multiple preferences.

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

Example
"""""""

.. code-block:: bash

    curl --request POST 'https://app.yumisign.com/api/v1/workspaces/1/workflows/1/preferences' \
        --header 'Content-Type: application/json' \
        --data-raw '{
            "preferences": [
                {
                    "name": "WorkflowMailAttachDocumentPreference",
                    "value": "0"
                },
                {
                    "name": "WorkflowNotificationCallbackUrlPreference",
                    "value": "https://my-website/app/webhooks/yumisign"
                }
            ]
        }'

.. code-block:: json

    [
        {
            "id": 1,
            "name": "WorkflowMailAttachDocumentPreference",
            "value": false,
            "type": "boolean"
        }
        {
            "id": 2,
            "name": "WorkflowNotificationCallbackUrlPreference",
            "value": "https://my-website/app/webhooks/yumisign",
            "type": "string"
        }
    ]