API v4

Execute a workflow action with signature

Execute a workflow action that requires an E-Signature.

{
    "documentId": 2842,
    "emails": [
        "signer1@email.com",
        "signer2@email.com"
    ],
    "cc": [
        "cc1@email.com",
        "cc2@email.com"
    ],
    "enforceSignOrder": true,
    "expireAfterDays": 7,
    "warnBeforeExpireDays": 2
}

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

NameTypeDescription

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

NameTypeDescription

x-api-key*

string

Your company's API key.

Authentication*

string

Authentication token.

Request Body

NameTypeDescription

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.

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)

true

PreviousExecute document workflow actionNextGet workflow actions

Last updated