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.

Name	Type	Value	Description
WorkflowMailAttachDocumentPreference	String	Must be “0” or “1”	Attach or detach the document on workflow emails. Default attached.
WorkflowNotificationCallbackUrlPreference	String	An url	A public url for receiving workflow notifications. Default none.
WorkflowNotificationCallbackUrlSecretPreference	String	Size equal 32	A secret key that is going to be used to sign response. Default none.
WorkflowNotificationCallbackUrlSslVerificationPreference	String	Must be “0” or “1”	Accept self signed certificate. Default true.

Example¶

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"
            }
        ]
    }'

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