Add workflow recipients

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

Warning

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

Parameters

  • recipients array | required

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

  • recipients[0].id string | optional

The optional recipient id to use in updating context.

  • recipients[0].name string | required

The recipient name.

  • recipients[0].email string | required

The recipient email address.

  • recipients[0].roles array | required

An array of roles for your recipient.

  • recipients[0].roles[0].type enum | required
Value Description
sign A recipient must sign the document
review A recipient must review the document
  • recipients[0].roles[0].color string | required

A hexadecimal color representing your recipient role.

Example

curl --request PUT 'https://app.yumisign.com/api/v1/workspaces/1/workflows/1/roles' \
    --header 'Content-Type: application/json' \
    --data-raw '{
        "recipients": [
            {
                "id": 1,
                "name": "Recipient name",
                "email": "recipient@email.com",
                "roles": [
                    {
                        "id":1,
                        "type": "sign",
                        "color": "#EE8320"
                    }
                ]
            }
        ]
    }'

[
    {
        "id": 1,
        "name": "Recipient name",
        "email": "recipient@email.com",
        "roles": [
            {
                "id": 1,
                "type": "sign",
                "color": "#EE8320"
            }
        ]
    }
]