Roger

Roger API documentation

## 🚀 Theneo

Theneo is the quickest, simplest way to generate high-quality, interactive API docs. Just import your API collection and we'll take care of the rest.

**⚠️ Note:** All of the stated endpoints and sections are for demonstration purposes only. Theneo does not manage payments API. Get sales data, itemize payments, push orders to POS, and more.The Orders API provides a one-stop shop for integrating advanced payment functionality. You can itemize payments with custom line items or catalog objects, send orders to real Point of Sale devices to be fulfilled, and more.In addition, the Orders API allows you to look through all of a seller's previous sales and returns itemization data, customer references, and other information from POS or online transactions.

&lt;img src="https://assets.website-files.com/61f7e03934c23c1dcc9c3cd4/6306089ecc13c15fe0a7e006_Main page_2 (with visual studoi code logo) 2.svg" alt="" height="237" width="322">

### Generate API Documentation

- Build interactive API docs
- Tailor you documentation
- Create and launch quickly
- Update easily within seconds
- Built for everyone
    

# Integrations

Import your collections manually or use our integrations to automatically migrate your work from:

- Swagger
- Postman
- Github
    

[  
](https://www.theneo.io/#)

[  
](https://app.theneo.io/signup)

Drafting a contract

Finding a TemplateId

Finding a FieldId

Generating an API Key

Creating and sending contracts

Sending a contract via email

Creating a contract without sending

Webhooks

Configuration

Handling webhook requests

Support

Theneo Demo TechCrunch

Production

Sandbox

<p class="slate-p" placeholder="Type / for widgets">Roger provides APIs for developers to connect data and functionality with your CRM or integration tools like Zapier.</p><p class="slate-p" placeholder="Type / for widgets"></p>

Roger provides APIs for developers to connect data and functionality with your CRM or integration tools like Zapier.

<p class="slate-p" placeholder="Type / for widgets">Developers can create links to the <strong class="slate-bold">Send contract (Page)</strong> with customizations.</p><h2 class="slate-h2">Customizations</h2><ul class="slate-ul"><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Term sheet:</strong> Pre-populate definitions of the term sheet.</div></li><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Form:</strong> Pre-populate answers to questions for the contract&apos;s intended recipient.</div></li><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Exhibits</strong>: Provide files to be included in the exhibits section.</div></li><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Signature block:</strong> Pre-populate the name and email address of the intended recipient.</div></li><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Custom arguments:</strong> Provide arbitrary data such as lead identifiers from your CRM, making it easier to trigger automations when contracts are signed.</div></li></ul><div style="text-align:center"><img src="https://theneo-prod-public.s3.amazonaws.com/images-1698175521552.png" alt="" style="width:70%"/></div><h3 class="slate-h3">Term sheet</h3><p class="slate-p" placeholder="Type / for widgets">To provide a definition to pre-populate in the <strong class="slate-bold">Term sheet</strong>, provide the field identifier (FieldId) and definition in the following format as a query parameter in the URL:</p><pre class="slate-CodeBlockElement slate-code_block"><div contenteditable="false"><div ><span aria-live="polite" aria-atomic="false" aria-relevant="additions text" ></span><div ><div ><div >Select...</div><div ><div  style="display:inline-block"><input type="text" autoCapitalize="none" autoComplete="off" autoCorrect="off" id="react-select-436-input" spellcheck="false" tabindex="0" value="" aria-autocomplete="list" style="box-sizing:content-box;width:1px;label:input;background:0;border:0;font-size:inherit;opacity:1;outline:0;padding:0;color:inherit"/><div style="position:absolute;top:0;left:0;visibility:hidden;height:0;overflow:scroll;white-space:pre"></div></div></div></div><div ><span ></span><div  aria-hidden="true"><svg height="20" width="20" viewBox="0 0 20 20" aria-hidden="true" focusable="false" ><path d="M4.516 7.548c0.436-0.446 1.043-0.481 1.576 0l3.908 3.747 3.908-3.747c0.533-0.481 1.141-0.446 1.574 0 0.436 0.445 0.408 1.197 0 1.615-0.406 0.418-4.695 4.502-4.695 4.502-0.217 0.223-0.502 0.335-0.787 0.335s-0.57-0.112-0.789-0.335c0 0-4.287-4.084-4.695-4.502s-0.436-1.17 0-1.615z"></path></svg></div></div></div></div></div><code class="keep-markup drop-tokens"><div class="slate-code_line">https://sign.thanksroger.com/request/<code class="slate-code">TemplateId</code>?id-<code class="slate-code">FieldId1</code>=<code class="slate-code">definition2</code>&amp;id-<code class="slate-code">FieldId2</code>=<code class="slate-code">definition2</code></div></code></pre><p class="slate-p" placeholder="Type / for widgets">The <strong class="slate-bold">FieldId</strong> can be found on the by switching to the <strong class="slate-bold">Editing template (Page)</strong><em class="slate-italic">.</em> See <a href="https://app.theneo.io/thanksroger/roger/drafting-a-contract/finding-a-template-fieldid" target="_self">Finding a template FieldId</a>.</p><h3 class="slate-h3">Exhibits</h3><p class="slate-p" placeholder="Type / for widgets">To specify a file to as an exhibit in the <strong class="slate-bold">Exhibits</strong> section, provide the field identifier (FieldId) and a publicly accessible URL to a PDF file:</p><pre class="slate-CodeBlockElement slate-code_block"><div contenteditable="false"><div ><span aria-live="polite" aria-atomic="false" aria-relevant="additions text" ></span><div ><div ><div >Select...</div><div ><div  style="display:inline-block"><input type="text" autoCapitalize="none" autoComplete="off" autoCorrect="off" id="react-select-437-input" spellcheck="false" tabindex="0" value="" aria-autocomplete="list" style="box-sizing:content-box;width:1px;label:input;background:0;border:0;font-size:inherit;opacity:1;outline:0;padding:0;color:inherit"/><div style="position:absolute;top:0;left:0;visibility:hidden;height:0;overflow:scroll;white-space:pre"></div></div></div></div><div ><span ></span><div  aria-hidden="true"><svg height="20" width="20" viewBox="0 0 20 20" aria-hidden="true" focusable="false" ><path d="M4.516 7.548c0.436-0.446 1.043-0.481 1.576 0l3.908 3.747 3.908-3.747c0.533-0.481 1.141-0.446 1.574 0 0.436 0.445 0.408 1.197 0 1.615-0.406 0.418-4.695 4.502-4.695 4.502-0.217 0.223-0.502 0.335-0.787 0.335s-0.57-0.112-0.789-0.335c0 0-4.287-4.084-4.695-4.502s-0.436-1.17 0-1.615z"></path></svg></div></div></div></div></div><code class="keep-markup drop-tokens"><div class="slate-code_line">https://sign.thanksroger.com/request/<code class="slate-code">TemplateId</code>?id-<code class="slate-code">FieldId1</code>=<code class="slate-code">url1</code>&amp;id-<code class="slate-code">FieldId2</code>=<code class="slate-code">url2</code></div></code></pre><p class="slate-p" placeholder="Type / for widgets">The <strong class="slate-bold">FieldId</strong> can be found on the by switching to the <strong class="slate-bold">Editing template (Page)</strong><em class="slate-italic">.</em> See <a href="https://app.theneo.io/thanksroger/roger/drafting-a-contract/finding-a-template-fieldid" target="_self">Finding a template FieldId</a>.</p><h3 class="slate-h3">Form</h3><p class="slate-p" placeholder="Type / for widgets">To provide an answer to pre-populate in the <strong class="slate-bold">Form</strong>, provide the field identifier (FieldId) and answer in the following format as a query parameter in the URL:</p><pre class="slate-CodeBlockElement slate-code_block"><div contenteditable="false"><div ><span aria-live="polite" aria-atomic="false" aria-relevant="additions text" ></span><div ><div ><div >Select...</div><div ><div  style="display:inline-block"><input type="text" autoCapitalize="none" autoComplete="off" autoCorrect="off" id="react-select-438-input" spellcheck="false" tabindex="0" value="" aria-autocomplete="list" style="box-sizing:content-box;width:1px;label:input;background:0;border:0;font-size:inherit;opacity:1;outline:0;padding:0;color:inherit"/><div style="position:absolute;top:0;left:0;visibility:hidden;height:0;overflow:scroll;white-space:pre"></div></div></div></div><div ><span ></span><div  aria-hidden="true"><svg height="20" width="20" viewBox="0 0 20 20" aria-hidden="true" focusable="false" ><path d="M4.516 7.548c0.436-0.446 1.043-0.481 1.576 0l3.908 3.747 3.908-3.747c0.533-0.481 1.141-0.446 1.574 0 0.436 0.445 0.408 1.197 0 1.615-0.406 0.418-4.695 4.502-4.695 4.502-0.217 0.223-0.502 0.335-0.787 0.335s-0.57-0.112-0.789-0.335c0 0-4.287-4.084-4.695-4.502s-0.436-1.17 0-1.615z"></path></svg></div></div></div></div></div><code class="keep-markup drop-tokens"><div class="slate-code_line">https://sign.thanksroger.com/request/<code class="slate-code">TemplateId</code>?id-<code class="slate-code">FieldId1</code>=<code class="slate-code">answer1</code>&amp;id-<code class="slate-code">FieldId2</code>=<code class="slate-code">answer2</code></div></code></pre><p class="slate-p" placeholder="Type / for widgets">The <strong class="slate-bold">FieldId</strong> can be found on the by switching to the <strong class="slate-bold">Editing template (Page)</strong><em class="slate-italic">.</em> See <a href="https://app.theneo.io/thanksroger/roger/drafting-a-contract/finding-a-template-fieldid" target="_self">Finding a template FieldId</a>.</p><p class="slate-p" placeholder="Type / for widgets">The answer should be specified according to the type of the field:</p><ul class="slate-ul"><li class="slate-li"><div style="position:relative">Plain text: The answer will be used as is.</div></li><li class="slate-li"><div style="position:relative">Choose one option: The answer must match the option exactly.</div></li><li class="slate-li"><div style="position:relative">Address: An address is made of 6 parts: <strong class="slate-bold">Address line 1</strong>, <strong class="slate-bold">Address line 2</strong>, <strong class="slate-bold">City</strong>, <strong class="slate-bold">State / Province</strong>, <strong class="slate-bold">Postal code</strong>, and <strong class="slate-bold">Country</strong>. Each of these 6 parts must be specified as a single string, using the underscore (<code class="slate-code">_</code>) character as the delimiter. For example, to specify the following address (notice that Address line 2 is empty):</div></li></ul><pre class="slate-CodeBlockElement slate-code_block"><div contenteditable="false"><div ><span aria-live="polite" aria-atomic="false" aria-relevant="additions text" ></span><div ><div ><div >Select...</div><div ><div  style="display:inline-block"><input type="text" autoCapitalize="none" autoComplete="off" autoCorrect="off" id="react-select-439-input" spellcheck="false" tabindex="0" value="" aria-autocomplete="list" style="box-sizing:content-box;width:1px;label:input;background:0;border:0;font-size:inherit;opacity:1;outline:0;padding:0;color:inherit"/><div style="position:absolute;top:0;left:0;visibility:hidden;height:0;overflow:scroll;white-space:pre"></div></div></div></div><div ><span ></span><div  aria-hidden="true"><svg height="20" width="20" viewBox="0 0 20 20" aria-hidden="true" focusable="false" ><path d="M4.516 7.548c0.436-0.446 1.043-0.481 1.576 0l3.908 3.747 3.908-3.747c0.533-0.481 1.141-0.446 1.574 0 0.436 0.445 0.408 1.197 0 1.615-0.406 0.418-4.695 4.502-4.695 4.502-0.217 0.223-0.502 0.335-0.787 0.335s-0.57-0.112-0.789-0.335c0 0-4.287-4.084-4.695-4.502s-0.436-1.17 0-1.615z"></path></svg></div></div></div></div></div><code class="keep-markup drop-tokens"><p class="slate-p" placeholder="Type / for widgets">123 Main St.
San Francisco, CA 94110
United States

<code class="slate-code">123 Main St.__San Francisco_CA_94110_United States</code></p></code></pre><h3 class="slate-h3">Signature block</h3><p class="slate-p" placeholder="Type / for widgets">To provide the name and/or email address to pre-populate in the <strong class="slate-bold">Signature block</strong>, use the following URL format:</p><pre class="slate-CodeBlockElement slate-code_block"><div contenteditable="false"><div ><span aria-live="polite" aria-atomic="false" aria-relevant="additions text" ></span><div ><div ><div >Select...</div><div ><div  style="display:inline-block"><input type="text" autoCapitalize="none" autoComplete="off" autoCorrect="off" id="react-select-440-input" spellcheck="false" tabindex="0" value="" aria-autocomplete="list" style="box-sizing:content-box;width:1px;label:input;background:0;border:0;font-size:inherit;opacity:1;outline:0;padding:0;color:inherit"/><div style="position:absolute;top:0;left:0;visibility:hidden;height:0;overflow:scroll;white-space:pre"></div></div></div></div><div ><span ></span><div  aria-hidden="true"><svg height="20" width="20" viewBox="0 0 20 20" aria-hidden="true" focusable="false" ><path d="M4.516 7.548c0.436-0.446 1.043-0.481 1.576 0l3.908 3.747 3.908-3.747c0.533-0.481 1.141-0.446 1.574 0 0.436 0.445 0.408 1.197 0 1.615-0.406 0.418-4.695 4.502-4.695 4.502-0.217 0.223-0.502 0.335-0.787 0.335s-0.57-0.112-0.789-0.335c0 0-4.287-4.084-4.695-4.502s-0.436-1.17 0-1.615z"></path></svg></div></div></div></div></div><code class="keep-markup drop-tokens"><div class="slate-code_line">https://sign.thanksroger.com/request/<code class="slate-code">TemplateId</code>?name=<code class="slate-code">fullName</code>&amp;email=<code class="slate-code">emailAddress</code></div></code></pre><h3 class="slate-h3">Custom arguments</h3><p class="slate-p" placeholder="Type / for widgets">String identifiers may be associated with a contract in the form of key-value pairs. Any key-value pairs (called <strong class="slate-bold">Custom arguments</strong>) associated with a contract will be retained and delivered with any configured Webhook events for the contract. Use this feature if you need to store the identifier of a lead from your CRM in the contract; when you receive the <strong class="slate-bold">Acceptance (Contract signed)</strong> event, you&apos;ll be able to update the corresponding lead in your CRM.</p><pre class="slate-CodeBlockElement slate-code_block"><div contenteditable="false"><div ><span aria-live="polite" aria-atomic="false" aria-relevant="additions text" ></span><div ><div ><div >Select...</div><div ><div  style="display:inline-block"><input type="text" autoCapitalize="none" autoComplete="off" autoCorrect="off" id="react-select-441-input" spellcheck="false" tabindex="0" value="" aria-autocomplete="list" style="box-sizing:content-box;width:1px;label:input;background:0;border:0;font-size:inherit;opacity:1;outline:0;padding:0;color:inherit"/><div style="position:absolute;top:0;left:0;visibility:hidden;height:0;overflow:scroll;white-space:pre"></div></div></div></div><div ><span ></span><div  aria-hidden="true"><svg height="20" width="20" viewBox="0 0 20 20" aria-hidden="true" focusable="false" ><path d="M4.516 7.548c0.436-0.446 1.043-0.481 1.576 0l3.908 3.747 3.908-3.747c0.533-0.481 1.141-0.446 1.574 0 0.436 0.445 0.408 1.197 0 1.615-0.406 0.418-4.695 4.502-4.695 4.502-0.217 0.223-0.502 0.335-0.787 0.335s-0.57-0.112-0.789-0.335c0 0-4.287-4.084-4.695-4.502s-0.436-1.17 0-1.615z"></path></svg></div></div></div></div></div><code class="keep-markup drop-tokens"><div class="slate-code_line">https://sign.thanksroger.com/request/<code class="slate-code">TemplateId</code>?custom-<code class="slate-code">key1</code>=<code class="slate-code">value1</code>&amp;custom-<code class="slate-code">key2</code>=<code class="slate-code">value2</code></div></code></pre><p class="slate-p" placeholder="Type / for widgets"></p>

To provide a definition to pre-populate in the 

, provide the field identifier (FieldId) and definition in the following format as a query parameter in the URL:

 can be found on the by switching to the 

To specify a file to as an exhibit in the 

 section, provide the field identifier (FieldId) and a publicly accessible URL to a PDF file:

To provide an answer to pre-populate in the 

, provide the field identifier (FieldId) and answer in the following format as a query parameter in the URL:

The answer should be specified according to the type of the field:

To provide the name and/or email address to pre-populate in the 

String identifiers may be associated with a contract in the form of key-value pairs. Any key-value pairs (called 

) associated with a contract will be retained and delivered with any configured Webhook events for the contract. Use this feature if you need to store the identifier of a lead from your CRM in the contract; when you receive the 

 event, you'll be able to update the corresponding lead in your CRM.

<p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets">Developers can generate API keys from the developer console. When creating the API key, the teams assigned to the API key will determine which templates are available.</p><p class="slate-p" placeholder="Type / for widgets"></p><div style="text-align:left"><img src="https://theneo-prod-public.s3.amazonaws.com/images-1699380258725.png" alt="" style="width:40%"/></div><p class="slate-p" placeholder="Type / for widgets">In order to validate an API key send a GET request to the  /apiKey endpoint. You will need to provide the API Key in the authorization </p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Developers can generate API keys from the developer console. When creating the API key, the teams assigned to the API key will determine which templates are available.

In order to validate an API key send a GET request to the  /apiKey endpoint. You will need to provide the API Key in the authorization 

Add your api key as the token to authorize requests.

Authorization

<p class="slate-p" placeholder="Type / for widgets">The Roger API allows developers the ability to create integrations that programmatically create contracts and optionally send them via email. Every Roger contract is based on a template. To create a contract, one can provide the values required by a template to the body of a request to the API. There are two options available to generate the contract, one that simply generates the contract in the Roger system and provides a URL for signing the agreement. The second option does all the aforementioned and will additionally attempt to send an email to the recipient, requesting them to sign the contract.</p><p class="slate-p" placeholder="Type / for widgets">Contracts created via the API can be viewed in the Roger UI like any other contract. You&apos;ll can filter to see the contracts created by a particular API key in the “Created by” menu in the top-right corner of the list of contracts.</p><p class="slate-p" placeholder="Type / for widgets"></p><div style="text-align:center"><img src="https://theneo-prod-public.s3.amazonaws.com/images-1701095538175.jpg" alt="" style="width:75%"/></div><p class="slate-p" placeholder="Type / for widgets"></p>

The Roger API allows developers the ability to create integrations that programmatically create contracts and optionally send them via email. Every Roger contract is based on a template. To create a contract, one can provide the values required by a template to the body of a request to the API. There are two options available to generate the contract, one that simply generates the contract in the Roger system and provides a URL for signing the agreement. The second option does all the aforementioned and will additionally attempt to send an email to the recipient, requesting them to sign the contract.

Contracts created via the API can be viewed in the Roger UI like any other contract. You'll can filter to see the contracts created by a particular API key in the “Created by” menu in the top-right corner of the list of contracts.

<p class="slate-p" placeholder="Type / for widgets">The <strong class="slate-bold">TemplateId</strong> can be found via the instructions at <a href="https://app.theneo.io/thanksroger/roger/drafting-a-contract/finding-a-templateid" target="_blank">Finding a TemplateId</a>. The contract will be based off the template, and represents preparing the contract as a sender. To specify a value of a term&apos;s definition or prefill an answer on behalf of the recipient, use its <strong class="slate-bold">FieldId</strong> as the key.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

. The contract will be based off the template, and represents preparing the contract as a sender. To specify a value of a term's definition or prefill an answer on behalf of the recipient, use its 

Specifies that an agreement has been accepted by the signer.

templateId

Make it easier to find the agreement later.

label

These are the parts of the term sheet that you need to fill out.

definitions

exhibits

This is to prefill questions on behalf of a signer. If you desire to not prefill, use an empty string.

answers

The name of the signer if known. If you do not know what to use, use an empty string.

name

The email of the signer if known. If you do not know what to use, use an empty string.

email

The attached "terms and conditions" PDF if it should be different from the template's

attachmentUrl

senderName

The email address that the contract will be sent from.

senderEmail

customArgs

Looks up the senderEmail and sends the agreement as if it were created by that user in the UI

asUser

Content-Type

agreementId

<p class="slate-p" placeholder="Type / for widgets">The <strong class="slate-bold">TemplateId</strong> can be found via the instructions at <a href="https://app.theneo.io/thanksroger/roger/drafting-a-contract/finding-a-templateid" target="_blank">Finding a TemplateId</a>. The contract will be based off the template, and represents preparing the contract as a sender. To specify a value of a term&apos;s definition or prefill an answer on behalf of the recipient, use its <strong class="slate-bold">FieldId</strong> as the key.</p><div class="slate-code_line"></div><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

<p class="slate-p" placeholder="Type / for widgets">Use webhooks to get real-time updates. Webhooks allow developers to receive an HTTP request when an agreement is signed.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Use webhooks to get real-time updates. Webhooks allow developers to receive an HTTP request when an agreement is signed.

<p class="slate-p" placeholder="Type / for widgets">If you have any questions, feedback, or need help with Roger APIs, please contact us at <strong class="slate-bold">support@thanksroger.com</strong>.</p><p class="slate-p" placeholder="Type / for widgets"></p>

If you have any questions, feedback, or need help with Roger APIs, please contact us at 

Sections