Skip to main content
arrow-left Back to Docusign.com
Question

Dynamically populate Custom Tab list from a REST API Call.

  • March 28, 2025
  • 1 reply
  • 17 views
R
Newcomer
Forum|alt.badge.img

I am attempting to populate the values in a custom tab (type: list) by making a call to a REST API we host.  The use case is that we are having residents of a senior living facility who are signing lease disclosures in Docusign, and we want them to indicate the name of the facility (from a list) and their resident ID from the electronic health records system they use at the facility.  Both of those lists are ever-changing, so they need to be dynamically updated as each envelope is created and sent.

My question is, is there a way to dynamically populate a custom tab list by calling a REST API?

1 reply

A
Conversation Starter
Forum|alt.badge.img+4
  • Adrian DevConversation Starter
  • Conversation Starter
  • 26 replies
  • March 30, 2025
Hello RichGunther,
 
Thank you for using Docusign Community.

We appreciate the detailed description. 

In this guide you can see how to create an envelope with fields using our API: 
How to Request Remote Signing | Docusign

To add a list field to your envelope you can use this structure inside the recipients Tabs object:
 
"listTabs": [
    {
        "documentId": "1",
        "pageNumber": "1",
        "tabType": "list",
        "xPosition": "257",
        "yPosition": "137",
        "tabLabel": "ListName",
        "listItems": [
            {
                "selected": "false",
                "text": "Item 1",
                "value": "InternalCode1"
            },
            {
                "selected": "false",
                "text": "Item 2",
                "value": "InternalCode2"
            },
            {
                "selected": "false",
                "text": "Item 3",
                "value": "InternalCode3"
            }
        ],
        "required": "true"            
    }
],

You can see all the options for your list here:
EnvelopeRecipientTabs Resource | REST API | Docusign

 
Best regards,
 
Adrian | Docusign Developer Support

Reply


Most helpful members this week

Code of Conduct

Docusign Community

Code of Conduct