I'm trying to use this route https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/get to get information on a specific Envelope in DocuSign, and I wanted to add the ?include=recipients parameter so as to get individual signers status too, but the parameter does not seem to do anything
Trying other values to include (documents, tags, etc). Doesn't change the response either.
Same result whether I try from my own code or from DS' "API explorer" tool
Am I using it wrong or is it a bug in the API?
This parameter (?include=recipients) is a new addition in the v2.1 API. You should ensure that the API endpoint you are calling has the v2.1 in the URL and not v2. You cannot use this feature with the v2.0 API. There are other reasons to use latest API 2.1 and it's supported by all SDKs.
Related
The Azure Integration Account features a tab on its configuration blade labelled "Callback URL":
This is documented in terms of generated API documentation but this doesn't say anything about its purpose. I can't find any documentation that mentions it.
What is this URL for?
Basically the callback uri we are using for reverifying/recheck the details of our integration account that we created earlier so that we can see properties of it. Likewise, we use jwt.io to see the content of any token.
For example:-
You can generate the callback url of an integration account using the below api with post method by passing the following parameter as mentioned in this MS DOC:-
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/listCallbackUrl?api-version=2016-06-01
I would like to create a custom connector into Power Automate to void the DocuSign envelope (contract).
But the issue is I don't want to pass the envelope id as in URL this envelope id will be dynamic/parameter.
I know, we can pass this url
https://{{environment}}.docusign.net/restapi/v2.1/accounts/{{AccountID}}/envelopes/{{envelopeId}}
but here envelopeId will be fixed, I want to send as dynamic or as parameterized one or any random one.
Please help how can I use a dynamic envelope ID not fixed one.
Your question is really a Power Automate question, so I added the Power-Automate tag. I just did a quick google search and found this solution for a dynamic URL by using braces for the variable in the URL path. See the screenshot below.
If that doesn't work, and there is no way to use a dynamic URL path value as the envelope ID, then you will need to create your own API and API server.
Your server would receive the envelope ID as a parameter in the request body, and then make the appropriate API call to DocuSign.
DocuSign's use of variables in the URL path is standard REST. So I'd be very surprised if Power Automate still does not support this API pattern. (But you may need to update to the latest Power Automate version.)
I'm using the DocuSign eSignature API, and am generating client code with the help of the openapi codegen (via these https://github.com/docusign/OpenAPI-Specifications).
Now I have to use the DocuSign Manage API (https://developers.docusign.com/docs/admin-api/), too, but I can't find any Swagger / OpenAPI definition for that?
Is it somewhere hidden, does it not exists, and are there plans to make it available at one point? Are there any other options, SDKs, anything or do I have to make these calls "manually"?
Unfortunately, the Swagger file for the Admin API is not yet available.
That's also why DocuSign doesn't yet have SDKs for the API yet.
I don't have access to any scheduling information on it.
I suggest that you handle any Admin API calls you need to do manually for now.
What language are you creating SDKs for with CodeGen? (Please answer in a comment or by editing your original question.)
I'm working on testing our application and have the need to simulate signing of a document via the API. These aren't real documents I just need to be able to set the signing the order in a specific order but I don't receive emails for recipients until the previous one has signed. So is it possible to use the DocuSign API to sign a "Sign Here" tab? Or do I have any other options?
I haven't been able to find any clear information on this topic although I fear the answer is not. Looking through DocuSign's REST API there's a couple of endpoints that suggests I might be able to do this but I'm not quite sure it's referencing what I'm looking to do. The following endpoint has a GET and PUT function but not sure it's what I want.
{{baseUrl}}/envelopes/{{envelopeId}}/recipients/{{recipientId}}/signature_image
No, the DocuSign API does not have a functionality for 'robo-signing'.
If the goal is to check routing order, you could change a Signer to a Carbon Copy recipient: CC roles are immediately completed.
For reference, the signature_image API calls allow you to view or change a user's adopted signatures. They shouldn't be used to apply a signature to a document.
The docusign website allows for me to save a document as a template, but I have not been able to find a way to do this programmatically through the API. Is there a simple way to save a document as a template?
Yes, you can create a Template via the API by issuing this request:
POST /v2/accounts/{accountId}/templates
The API documentation contains details about this operation.
UPDATE
Do I understand correctly that your goal is to create a Template that's based upon an existing DocuSign Document, i.e., to mimic the following functionality in the DocuSign web UI?
If that's the case, then I'm not aware of any single API call that can do this. Instead, I believe you'll need to issue a series of API calls, to retrieve info about the existing Document(s) and then create the new Template using that info:
1) Get information about the existing DocuSign Document (envelope): GET /v2/accounts/{accountId}/envelopes/{envelopeId} (docs)
This operation returns recipient info (including tabs for each recipient) as well as envelope data like email subject, email body, reminders, etc. It also returns a documentsUri property that you can use to get the document(s) that belong to the envelope.
2) Get the list of document(s) that the envelope contains by issuing a GET request to the URI specified by the documentsUri from the prior response. (docs)
This operation returns information about each document in the specified envelope, but does not return document contents.
3) For each document listed in the prior API response, issue a GET request to the URI specified by the uri property for the document. (docs)
4) Finally, create a new Template using the data that you received in response to the previous API requests: POST /v2/accounts/{accountId}/templates (docs)
Note: As a final note -- if you're using one of the DocuSign SDKs, it's possible that there might be a function that you can call to implement this scenario, without having to piece together all of these API calls yourself. I'm not familiar enough with the SDKs to say whether or not they provide this type of functionality, but it'd be worth checking for, if you're using an SDK.