Execute a workflow action with signature

Execute a workflow action that requires an E-Signature.

Execute workflow action

PUT https://ris.rightsline.com/v4/:entityType/:id/execute-signature-workflow-action/:actionID

This endpoint allows you to execute a workflow action on an entity and sends a document for E-Signature.

Path Parameters

Name	Type	Description
entityType*	string	The type of entity to perform the workflow action on. ex: deal, catalog-item, financial-document, etc.
id*	integer	ID of the entity to perform the action on.
actionID*	integer	ID of the action to take.

Headers

Name	Type	Description
x-api-key*	string	Your company's API key.
Authentication*	string	Authentication token.

Request Body

Name	Type	Description
documentId*	integer	The record ID of the document to send for E-Signature. Must be related to parent entity.
emails*	string[]	An array of email addresses from whom you require signatures. . Either emails or recipients is required.
recipients*	Recipient[]	An array of Recipients. Either emails or recipients is required.
cc*	string[]	An array of email addresses that will get a copy of the signed document.
enforceSignOrder	boolean	If true - Signatories must sign in the order they are listed in the request. If false (or not included in request) - Document sent to all signatories simultaneously.
expireAfterDays	integer	Expire the signature document if it is not signed after a number of days. (1-999)
warnBeforeExpireDays	integer	If expireAfterDays is set, send reminder email a number of days before document expiration. (must be less than expireAfterDays)

Recipient object

Name	Type	Description
email	string	An email address.
role	string	AGENT - This recipient will receive the document and can either specify a signer in their place or sign the document themselves. SIGNER - This recipient must sign the document.

Workflow action with signature using emails

{
    "documentId": 2842,
    "emails": [
        "[email protected]",
        "[email protected]"
    ],
    "cc": [
        "[email protected]",
        "[email protected]"
    ],
    "enforceSignOrder": true,
    "expireAfterDays": 7,
    "warnBeforeExpireDays": 2
}

Workflow action with signature using recipients

{
    "documentId": 2842,
    "recipients": [
        {
            "email": "[email protected]",
            "role": "AGENT"
        },
         {
            "email": "[email protected]",
            "role": "SIGNER"
        }
    ],
    "cc": [
        "[email protected]",
        "[email protected]"
    ],
    "enforceSignOrder": true,
    "expireAfterDays": 7,
    "warnBeforeExpireDays": 2
}

200 Workflow action executed successfully.

true