CODEWITHSUNDEEP
docusignapi
Nadeem Shaikh
Nadeem Shaikh

Reputation: 329

How to set a Custom tab field's value?

I have to Populate Custom field value from System using Docusign Api, Is there any api available ?

So far i did following things

  1. created a custom field and put it on Document like below image.

screenshot of custom tab

  1. Used

    POST /v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields

It gave an error:

enter image description here

Is there any way to populate custom field value before send to particular signer? Need a help.

Upvotes: 0

Views: 593

Answers (1)

Larry K
Larry K

Reputation: 49104

First, unfortunately, the term "custom field" is often used for two different features in the DocuSign system:

Envelopes can have metadata fields. These fields are not shown to any recipients. Their full name is Envelope Custom Fields. They are managed by using the Admin Tool. See the screenshot of the Admin tool's navigation panel:

Admin Tool navigation panel

Envelope Custom Fields can be set by the sender of the envelope (or via the API). They are visible on the Cert of completion and can be accessed via the API.

As far as I can tell from your question, this is NOT what you're doing.

Tabs can have customized settings. Since tabs (API terminology) are called fields in the web user interface, once they are customized, some call them Custom Fields. But the better term is Document Custom Fields

They are managed at the account level, so you can also use the Admin Tool to manage them.

API for populating Document Custom Fields You can set their values when you create the envelope.

Here is a create envelope example for setting a Document Custom Field which is a drop down field. The envelope is being created from a template.

Note how the template roles are set, and for the role which has associated tabs, just the tab value is being set.

{
    "status": "sent",
    "templateId": "77b6fbef-1448-4ac3-819f-253a9e1cb08e",
    "templateRoles": [
        {
            "clientUserId": "1000",
            "email": "[email protected]",
            "name": "Larry Kluger",
            "roleName": "signer",
            "tabs": {
                "listTabs": [
                    {
                        "tabLabel": "Custom Drop down",
                        "value": "Option 2"
                    }
                ],
            }
        },
        {
            "email": "[email protected]",
            "name": "Susan Kluger",
            "roleName": "cc"
        }
    ]
}

Upvotes: 1

Related Questions