Скачать или смотреть Resolving the Issue of Tooltips Not Being Passed Through REST API to DocuSign

Learn how to effectively troubleshoot and resolve the problem of tooltips not appearing in DocuSign when using the REST API with this step-by-step guide.
---
This video is based on the question https://stackoverflow.com/q/62707528/ asked by the user 'InfinitySamurai' ( https://stackoverflow.com/u/13856796/ ) and on the answer https://stackoverflow.com/a/62720486/ provided by the user 'Inbar Gazit' ( https://stackoverflow.com/u/3255871/ ) at 'Stack Overflow' website. Thanks to these great users and Stackexchange community for their contributions.

Visit these links for original content and any more details, such as alternate solutions, latest updates/developments on topic, comments, revision history etc. For example, the original title of the Question was: Tooltips not being passed through REST API to docusign

Also, Content (except music) licensed under CC BY-SA https://meta.stackexchange.com/help/l...
The original Question post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license, and the original Answer post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license.

If anything seems off to you, please feel free to write me at vlogize [AT] gmail [DOT] com.
---
Troubleshooting DocuSign Tooltips in REST API Requests

When working with DocuSign's REST API, developers often encounter issues while creating envelopes and including various tab properties. One common challenge arises when attempting to add tooltips to documents, which unfortunately do not always populate as expected. If you're facing this problem, keep reading as we explore effective solutions to ensure your tooltips appear correctly in DocuSign.

The Problem

A user reported problems getting the tooltip for a text tab to populate when making a create envelope request. Although they can successfully send their complex documents, they noticed that the tooltip field was not displayed in the DocuSign portal or on the signing screens. Here’s a portion of their code for reference:

[[See Video to Reveal this Text or Code Snippet]]

Despite these settings, the tooltip field was absent, causing confusion and hindering the user experience during the signing process.

Solution

Changing the Key from "tooltip" to "name"

The solution to the tooltip issue is quite straightforward but requires a small adjustment in your API request. Instead of using the tooltip key to define your tooltip text in the tab properties, you should use the name key instead. Here’s the corrected version of the initial code:

[[See Video to Reveal this Text or Code Snippet]]

Breakdown of Changes

Key Change: Replace the "tooltip" key with the "name" key.

Maintain Consistency: Ensure that the rest of your tab settings remain unaffected by this change.

Key Features to Remember

Anchor String: This helps DocuSign know where to place the tab in the document.

Validation Pattern: This regex pattern ensures the date input follows the DD/MM/YYYY format.

Validation Message: This message informs users when they fail to input the date correctly.

Conclusion

Incorporating tooltips into your DocuSign envelopes via the REST API does not have to be a complex issue. By simply changing the key from tooltip to name, you can ensure the tooltips appear correctly on the signing screens. This small adjustment can significantly improve user experience and document clarity. If you continue to experience issues or have further questions, don't hesitate to reach out for additional assistance.