I have the template id and I want to fetch all the envelopes for this template. What is the right and the best way to get this information?
So, if your integration/app sent these envelopes and you put some code that will allow you to do in the future - you can do that.
However, if you have envelopes sent from a template without anything in there to indicate where they came from - there's no way to do that.
The system considers the envelope and template independent objects and there's no correlation (no FKs in the database). When you ask for an envelope to be created from a template, the template is simply copied into a fresh new envelope with everything in it. That's it.
So, for example, if you have unique documents, recipients, fields, etc. etc. you can use them to ascertain the template, but there's nothing directly tying the templateId.
Blog post that covers this topic -
https://www.docusign.com/blog/developers/the-trenches-track-your-templates-envelope-custom-fields
Related
Docusign Provides a way to get tabs data for a single document in a template by specifying documentId. I could not find a way to get tabs data for all documents included in a template.
There's no data in templates, templates are not sent, or acted upon.
Only envelopes have data, and you mentioned you can get data from envelopes.
Now, maybe you meant how can I aggregate ALL the DATA from ALL envelopes created from a template.
If that's what you meant, then you may have to first find all these envelopes.
To do this, include some meta-data in your envelopes using custom fields. These will be used to later find them first, so that then you can get all the data from them using the search envelope endpoint (that can also return data).
If you're looking to see which tabs are placed on a template, you can do so by making a Templates::Get call with ?include=recipients,tabs.
As Inbar states, this won't get you any tab values (except one that are pre-populated by the template creator), as the template itself isn't what a signer interacts with - an envelope is sent that references the template. So if you're trying to collect data from your signers, you would need to be pulling tab data from an envelope instead.
I was a user of Right Signature, where we can create merge fields, and we can send the data through post request,
I have recently migrated to Docusign,
I see that they have prefil fields.
What I want to achieve is, Create Prefil fields, like Owner Name, Owner Email, etc,
And supply this fields through DOCUSIGN API, and send them. Is this functionality even possible.
I could not find any documentation, or perhaps I do not have the right search. Can some one point me to it, what will be the syntax for sending the templates, with prefil fields.
Thanks.
Anything you can do from the web app - you can do from API.
The term "pre-fill fields" means something very specific, but I'm not sure exactly what you want.
Any field in DocuSign can be "pre-filled" such that the value is set by the sender. The field can be read-only or can be edited by the person that it is assigned to.
You can also use pre-fill fields that are specific for the sender and therefore cannot be modified by anyone except the sender.
All of this is possible with the API, I suggest you first try it with the web app to understand. You can do everything for free with a developer account - try it and see if it serves your need.
I'm working on creating a gateway using the docusign API.
And i wonder if it's possible to add dynamically signers through a form.
I have tried many technique but none of them have worked.
For me one of the solution would be to add the signers with their parameters to a list in the model and use this list as a parameter of the controller, but i don't know if the Api have special limitation.
I will share you my code if you need it !
Thank you for your responses.
I think you want to do bulk send, but not sure.
Bulk Send is a feature where you send the same envelope (set of documents with tags etc.) to different signers (recipients). You then set the list and the system clones the original envelope many times and sends it to each user in turn.
Code example showcasing how to do this in 8 different languages can be found here:
https://developers.docusign.com/docs/esign-rest-api/how-to/bulk-send-envelopes
A little bit of background as to what my goal is and why I need to get the email from the Template (just in case there is a better way):
I added three signers to a docusign template I created, one who is supposed to get the information from my code and two who I have entered their info directly into the email fields. My issue is that when I look at the SDK/API I don't see a way to add the missing email\name and use the default information I added in the Docusign dashboard for the Template.
The solution I came up with was to get a list of the signers from the Template (to add them to the Envelope), but I am not seeing a way to do that in their documentation. Any help provided would be greatly appreciated!
You can get the list of signers from the template using below call
GET /v2/accounts/{accountId}/templates/{templateId}/recipients
Details are available at, TemplateRecipients: list.
I want to make sure I am on the right track as I have been having some problems getting started with the API. I am looking to maintain a list of product application PDFs as templates on docusign. When a customer comes to our site and wants a particular product they need to fill out an application form. All the data would be collected on our site. I would then want to:
Create an envolope with the customer (and potentially other parties) that need to sign the document
Fill in the form fields from data collected on our site
Send the envelope out for signature and monitor the progress.
So in doing this I am trying to build this up a piece at a time and first task is to make sure that I can provide form data to docusign. I create a template with the docusign web user interface and all of the form fields seem to be preserved. However when I try and retrieve the template with API
https://demo.docusign.net/restapi/v2/accounts/xxxx/templates/yyyy
I see a very short response with an envelopeTemplateDefinition showing the correct name for the template but no documents object and no custom fields object. I have also tried this by creating an envelope with the document (in draft) but with similar results.
My apologies in advance for this newbie question.
I've repro'd the issue you describe -- i.e., the Response I get from a GET Template request contains only very limited information and is thereby not consistent with the expected Response as documented on pages 194-196 of the DocuSign REST API guide (http://www.docusign.com/sites/default/files/REST_API_Guide_v2.pdf). Not sure if this is a bug with the GET Template operation or with the Documentation -- someone at DocuSign will need to confirm (#Ergin).
In light of this limitation with the GET Template operation, you can alternatively retrieve the recipient information (including tabs) and document information about a Template by using the GET Envelope Recipients and GET Envelope Documents operations -- just specify the TEMPLATE Id in place of the Envelope Id, as shown here:
GET https://{{env}}.docusign.net/restapi/{{version}}/accounts/{{acctId}}/envelopes/{templateId}/documents
GET https://{{env}}.docusign.net/restapi/{{version}}/accounts/{{acctId}}/envelopes/{templateId}/recipients?include_tabs=true