•••
 
Documentation   /   Reference: workflows   /   Reserved variables
 
 

Reserved variables

 

When a workflow creates or changes a document (specific_document, auto_document, copy_document, update_document), these names in ---pass_variables set the document's built-in fields. All are optional.

General

Variable Sets Value
description The document's name or description Text
counterparty The other party's name ({{a_counterparty_name}}) Text
address The counterparty's address Text
name The signatory's name Text
title The signatory's job title Text
email The signatory's email address Email address
date_start The document's date A date or timestamp
date_end The document's end date A date or timestamp
folder Where the document is saved A folder name
tag A tag for the document Text
redirect_link Where to send the signatory after signing or submitting URL
alert_view Alert you when the document is viewed y
alert_accept Alert you when the document is signed or submitted y
remind Send daily reminders to sign y
private Only your team can view the document. Don't use it on documents to be signed by people outside your team. y
suppress_markup Counterparties only see the clean version, not the mark-up y
password A password needed to view the document Text
alt_key A human-readable alternative key for the document Lowercase text

Signature blocks

Variable Sets
{signature_id}:name The name of the person signing that block
{signature_id}:email Their email address
{signature_id}:title Their job title

{signature_id} is the block's ---id. See Signature blocks.

Example

---pass_variables:counterparty_IS_{{supplier}}_AND_date_start_IS_{{*today}}_AND_folder_IS_Suppliers_AND_remind_IS_y_AND_supplier_sig:email_IS_{{supplier_email}}

Any other name sets the template variable of that name.