From cdd83f15149b875b99ca6564e15ac097158edac0 Mon Sep 17 00:00:00 2001 From: inbargazit Date: Fri, 29 Dec 2023 14:16:32 -0800 Subject: [PATCH] Updating manifest for code example launchers --- manifest/CodeExamplesManifest.json | 2967 ++++++++++++++-------------- 1 file changed, 1486 insertions(+), 1481 deletions(-) diff --git a/manifest/CodeExamplesManifest.json b/manifest/CodeExamplesManifest.json index b6664d5..bcc5680 100644 --- a/manifest/CodeExamplesManifest.json +++ b/manifest/CodeExamplesManifest.json @@ -43,1640 +43,1645 @@ "APIs": [ { "Name": "eSignature", - "Groups": [ + "Groups": [ + { + "Name": "Sending a signature request (remote signing)", + "Examples": [ { - "Name": "Requesting a signature", - "Examples": [ + "ExampleNumber": 2, + "CFREnabled": "AllAccounts", + "ExampleName": "Send an envelope with a remote (email) signer and cc recipient", + "ExampleDescription": "The envelope includes a pdf, Word, and HTML document. Anchor text(AutoPlace) is used to position the signing fields in the documents.", + "LinksToAPIMethod": [ + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/", + "PathName": "Envelopes:create" + } + ], + "Forms": [ { - "ExampleNumber": 2, - "CFREnabled": "AllAccounts", - "ExampleName": "Send an envelope with a remote (email) signer and cc recipient", - "ExampleDescription": "The envelope includes a pdf, Word, and HTML document. Anchor text(AutoPlace) is used to position the signing fields in the documents.", - "LinksToAPIMethod": [ + "Inputs": [ { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/", - "PathName": "Envelopes:create" - } - ], - "Forms": [ - { - "Inputs": [ - { - "InputName": "Signer Email", - "InputPlaceholder": "pat@example.com" - }, - { - "InputName": "Signer Name", - "InputPlaceholder": "Pat Johnson" - }, - { - "InputName": "CC Email", - "InputPlaceholder": "pat@example.com" - }, - { - "InputName": "CC Name", - "InputPlaceholder": "Pat Johnson" - } - ] + "InputName": "Signer Email", + "InputPlaceholder": "pat@example.com" + }, + { + "InputName": "Signer Name", + "InputPlaceholder": "Pat Johnson" + }, + { + "InputName": "CC Email", + "InputPlaceholder": "pat@example.com" + }, + { + "InputName": "CC Name", + "InputPlaceholder": "Pat Johnson" } - ], - "ResultsPageText": "The envelope has been created and sent!
Envelope ID {0}." - }, + ] + } + ], + "ResultsPageText": "The envelope has been created and sent!
Envelope ID {0}." + }, + { + "ExampleNumber": 9, + "CFREnabled": "AllAccounts", + "ExampleName": "Send an envelope using a template", + "ExampleDescription": "The envelope is defined by the template. The signer and cc recipient name and email are used to fill in the template's roles.", + "LinksToAPIMethod": [ + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/", + "PathName": "Envelopes:create" + } + ], + "RedirectsToOtherCodeExamples": [ { - "ExampleNumber": 1, - "CFREnabled": "NonCFR", - "ExampleName": "Request a signature through your app (embedded signing)", - "ExampleDescription": "Sends an envelope, then uses embedded signing for the first signer. With embedded signing, DocuSign signing is initiated from your website.", - "LinksToAPIMethod": [ + "CodeExampleToRedirectTo": 8, + "RedirectText": "

Prerequisite: Please first create the template using Create a template.

" + } + ], + "Forms": [ + { + "FormName": "

The template you created via Create a template will be used.
The document list is from your results for List an envelope's documents.

", + "Inputs": [ { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/", - "PathName": "Envelopes:create" + "InputName": "Signer Email", + "InputPlaceholder": "pat@example.com" }, { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeviews/createrecipient/", - "PathName": "EnvelopeViews:createRecipient" - } - ], - "Forms": [ - { - "Inputs": [ - { - "InputName": "Signer Email", - "InputPlaceholder": "pat@example.com" - }, - { - "InputName": "Signer Name", - "InputPlaceholder": "Pat Johnson" - } - ] + "InputName": "Signer Name", + "InputPlaceholder": "Pat Johnson" + }, + { + "InputName": "CC Email", + "InputPlaceholder": "pat@example.com" + }, + { + "InputName": "CC Name", + "InputPlaceholder": "Pat Johnson" } - ], - "ResultsPageText": "" + ] + } + ], + "ResultsPageText": "The envelope has been created and sent!
Envelope ID {0}." + }, + { + "ExampleNumber": 42, + "CFREnabled": "NonCFR", + "ExampleName": "Request a signature by email with document generation", + "ExampleDescription": "Creates an envelope from a template with a document that is dynamically generated to include all the customized data specified by the sender.", + "LinksToAPIMethod": [ + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/templates/templates/create/", + "PathName": "Templates:create" + }, + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/templates/templatedocuments/update/", + "PathName": "TemplateDocuments:update" + }, + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/templates/templaterecipienttabs/create/", + "PathName": "TemplateRecipientTabs:create" + }, + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/", + "PathName": "Envelopes:create" + }, + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/documentgeneration/getenvelopedocgenformfields/", + "PathName": "DocumentGeneration:getEnvelopeDocGenFormFields" + }, + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/documentgeneration/updateenvelopedocgenformfields/", + "PathName": "DocumentGeneration:updateEnvelopeDocGenFormFields" }, { - "ExampleNumber": 41, - "CFREnabled": "CFROnly", - "ExampleName": "Request a signature through your app (embedded signing) with a CFR Part 11 account", - "ExampleDescription": "Sends an envelope, then uses embedded signing with recipient authentication by phone for the first signer. With embedded signing, DocuSign signing is initiated from your website.", - "LinksToAPIMethod": [ + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/update/", + "PathName": "Envelopes:update" + } + ], + "Forms": [ + { + "Inputs": [ + { + "InputName": "Candidate Email", + "InputPlaceholder": "pat@example.com" + }, + { + "InputName": "Candidate Name", + "InputPlaceholder": "Pat Johnson" + }, + { + "InputName": "Manager Name", + "InputPlaceholder": "Pat Johnson" + }, { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeworkflowdefinition/getenvelopeworkflowdefinition/", - "PathName": "EnvelopeWorkflowDefinition:getEnvelopeWorkflowDefinition" + "InputName": "Job Title" }, { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/", - "PathName": "Envelopes:create" + "InputName": "Salary" }, { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeviews/createrecipient/", - "PathName": "EnvelopeViews:createRecipient" + "InputName": "Start Date", + "InputPlaceholder": "mm/dd/yyyy" } - ], - "Forms": [ - { - "Inputs": [ - { - "InputName": "Signer Email", - "InputPlaceholder": "pat@example.com" - }, - { - "InputName": "Signer Name", - "InputPlaceholder": "Pat Johnson" - }, - { - "InputName": "Signer Country Code", - "InputPlaceholder": "1" - }, - { - "InputName": "Signer Phone Number", - "InputPlaceholder": "4155551212" - } - ] + ] + } + ], + "ResultsPageText": "The envelope has been created and sent!
Envelope ID {0}." + }, + { + "ExampleNumber": 37, + "CFREnabled": "NonCFR", + "ExampleName": "Request a signature by SMS or WhatsApp delivery", + "ExampleDescription": "Sends a signature request via an SMS or WhatsApp message.", + "LinksToAPIMethod": [ + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/", + "PathName": "Envelopes::create" + } + ], + "Forms": [ + { + "Inputs": [ + { + "InputName": "Signer Country Code", + "InputPlaceholder": "1" + }, + { + "InputName": "Signer Phone Number", + "InputPlaceholder": "4155551212" + }, + { + "InputName": "Signer Name", + "InputPlaceholder": "Pat Johnson" + }, + { + "InputName": "CC Country Code", + "InputPlaceholder": "1" + }, + { + "InputName": "CC Phone Number", + "InputPlaceholder": "4155551212" + }, + { + "InputName": "CC Name", + "InputPlaceholder": "Pat Johnson" + }, + { + "InputName": "Delivery Method:" + }, + { + "InputName": "SMS" + }, + { + "InputName": "WhatsApp" } - ], - "ResultsPageText": "" + ] + } + ], + "ResultsPageText": "The envelope has been created and sent!
Envelope ID {0}." + } + ] + }, + { + "Name": "Hosting the signing experience (embedded signing)", + "Examples": [ + { + "ExampleNumber": 1, + "CFREnabled": "NonCFR", + "ExampleName": "Request a signature through your app (embedded signing)", + "ExampleDescription": "Sends an envelope, then uses embedded signing for the first signer. With embedded signing, DocuSign signing is initiated from your website.", + "LinksToAPIMethod": [ + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/", + "PathName": "Envelopes:create" }, { - "ExampleNumber": 9, - "CFREnabled": "AllAccounts", - "ExampleName": "Send an envelope using a template", - "ExampleDescription": "The envelope is defined by the template. The signer and cc recipient name and email are used to fill in the template's roles.", - "LinksToAPIMethod": [ + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeviews/createrecipient/", + "PathName": "EnvelopeViews:createRecipient" + } + ], + "Forms": [ + { + "Inputs": [ { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/", - "PathName": "Envelopes:create" - } - ], - "RedirectsToOtherCodeExamples": [ + "InputName": "Signer Email", + "InputPlaceholder": "pat@example.com" + }, { - "CodeExampleToRedirectTo": 8, - "RedirectText": "

Prerequisite: Please first create the template using Create a template.

" + "InputName": "Signer Name", + "InputPlaceholder": "Pat Johnson" } - ], - "Forms": [ - { - "FormName": "

The template you created via Create a template will be used.
The document list is from your results for List an envelope's documents.

", - "Inputs": [ - { - "InputName": "Signer Email", - "InputPlaceholder": "pat@example.com" - }, - { - "InputName": "Signer Name", - "InputPlaceholder": "Pat Johnson" - }, - { - "InputName": "CC Email", - "InputPlaceholder": "pat@example.com" - }, - { - "InputName": "CC Name", - "InputPlaceholder": "Pat Johnson" - } - ] - } - ], - "ResultsPageText": "The envelope has been created and sent!
Envelope ID {0}." + ] + } + ], + "ResultsPageText": "" + }, + { + "ExampleNumber": 41, + "CFREnabled": "CFROnly", + "ExampleName": "Request a signature through your app (embedded signing) with a CFR Part 11 account", + "ExampleDescription": "Sends an envelope, then uses embedded signing with recipient authentication by phone for the first signer. With embedded signing, DocuSign signing is initiated from your website.", + "LinksToAPIMethod": [ + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeworkflowdefinition/getenvelopeworkflowdefinition/", + "PathName": "EnvelopeWorkflowDefinition:getEnvelopeWorkflowDefinition" + }, + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/", + "PathName": "Envelopes:create" }, { - "ExampleNumber": 13, - "CFREnabled": "AllAccounts", - "ExampleName": "Embedded Signing Ceremony from a template with an added document", - "ExampleDescription": "

This example sends an envelope based on a template.

In addition to the template's document(s), the example adds an additional document to the envelope by using the Composite Templates feature.

", - "LinksToAPIMethod": [ + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeviews/createrecipient/", + "PathName": "EnvelopeViews:createRecipient" + } + ], + "Forms": [ + { + "Inputs": [ { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/", - "PathName": "Envelopes:create" + "InputName": "Signer Email", + "InputPlaceholder": "pat@example.com" }, { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeviews/createrecipient/", - "PathName": "EnvelopeViews:createRecipient" - } - ], - "RedirectsToOtherCodeExamples": [ + "InputName": "Signer Name", + "InputPlaceholder": "Pat Johnson" + }, { - "CodeExampleToRedirectTo": 8, - "RedirectText": "

Prerequisite: Please first create the template using Create a template.

" - } - ], - "Forms": [ - { - "FormName": "

The template you created via Create a template will be used.

", - "Inputs": [ - { - "InputName": "Signer Email", - "InputPlaceholder": "pat@example.com" - }, - { - "InputName": "Signer Name", - "InputPlaceholder": "Pat Johnson" - }, - { - "InputName": "CC Email", - "InputPlaceholder": "pat@example.com" - }, - { - "InputName": "CC Name", - "InputPlaceholder": "Pat Johnson" - }, - { - "InputName": "Item" - }, - { - "InputName": "Quantity" - } - ] + "InputName": "Signer Country Code", + "InputPlaceholder": "1" + }, + { + "InputName": "Signer Phone Number", + "InputPlaceholder": "4155551212" } - ], - "ResultsPageText": "" + ] + } + ], + "ResultsPageText": "" + }, + { + "ExampleNumber": 13, + "CFREnabled": "AllAccounts", + "ExampleName": "Embedded Signing Ceremony from a template with an added document", + "ExampleDescription": "

This example sends an envelope based on a template.

In addition to the template's document(s), the example adds an additional document to the envelope by using the Composite Templates feature.

", + "LinksToAPIMethod": [ + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/", + "PathName": "Envelopes:create" }, { - "ExampleNumber": 37, - "CFREnabled": "NonCFR", - "ExampleName": "Request a signature by SMS or WhatsApp delivery", - "ExampleDescription": "Sends a signature request via an SMS or WhatsApp message.", - "LinksToAPIMethod": [ + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeviews/createrecipient/", + "PathName": "EnvelopeViews:createRecipient" + } + ], + "RedirectsToOtherCodeExamples": [ + { + "CodeExampleToRedirectTo": 8, + "RedirectText": "

Prerequisite: Please first create the template using Create a template.

" + } + ], + "Forms": [ + { + "FormName": "

The template you created via Create a template will be used.

", + "Inputs": [ { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/", - "PathName": "Envelopes::create" - } - ], - "Forms": [ - { - "Inputs": [ - { - "InputName": "Signer Country Code", - "InputPlaceholder": "1" - }, - { - "InputName": "Signer Phone Number", - "InputPlaceholder": "4155551212" - }, - { - "InputName": "Signer Name", - "InputPlaceholder": "Pat Johnson" - }, - { - "InputName": "CC Country Code", - "InputPlaceholder": "1" - }, - { - "InputName": "CC Phone Number", - "InputPlaceholder": "4155551212" - }, - { - "InputName": "CC Name", - "InputPlaceholder": "Pat Johnson" - }, - { - "InputName": "Delivery Method:" - }, - { - "InputName": "SMS" - }, - { - "InputName": "WhatsApp" - } - ] + "InputName": "Signer Email", + "InputPlaceholder": "pat@example.com" + }, + { + "InputName": "Signer Name", + "InputPlaceholder": "Pat Johnson" + }, + { + "InputName": "CC Email", + "InputPlaceholder": "pat@example.com" + }, + { + "InputName": "CC Name", + "InputPlaceholder": "Pat Johnson" + }, + { + "InputName": "Item" + }, + { + "InputName": "Quantity" } - ], - "ResultsPageText": "The envelope has been created and sent!
Envelope ID {0}." + ] + } + ], + "ResultsPageText": "" + }, + { + "ExampleNumber": 44, + "CFREnabled": "NonCFR", + "ExampleName": "Request a signature using focused view", + "ExampleDescription": "Sends an envelope, then uses focused view for the signer.", + "LinksToAPIMethod": [ + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/", + "PathName": "Envelopes:create" }, { - "ExampleNumber": 14, - "CFREnabled": "NonCFR", - "ExampleName": "Send an envelope with an order form and payment field", - "ExampleDescription": "Anchor text (AutoPlace) is used to position the fields in the documents.", - "Notes": "
Note: This example will only work if the sender's DocuSign account is set up with a DocuSign payment gateway. Since the Payment Gateway ID is set in the configuration file, you will need to run your own instance of this project to set it.
", - "LinksToAPIMethod": [ + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeviews/createrecipient/", + "PathName": "EnvelopeViews:createRecipient" + } + ], + "Forms": [ + { + "Inputs": [ { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/", - "PathName": "Envelopes:create" + "InputName": "Signer Email", + "InputPlaceholder": "pat@example.com" }, { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeviews/createrecipient/", - "PathName": "EnvelopeViews:createRecipient" + "InputName": "Signer Name", + "InputPlaceholder": "Pat Johnson" } - ], - "RedirectsToOtherCodeExamples": [ + ] + } + ], + "ResultsPageText": "The document has been embedded with focused view.", + "SkipForLanguages": "bash;powershell" + }, + { + "ExampleNumber": 39, + "CFREnabled": "NonCFR", + "ExampleName": "Send an envelope to an In Person Signer", + "ExampleDescription": "Demonstrates how to host an In Person Signing session with embedded signing.", + "LinksToAPIMethod": [ + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/", + "PathName": "Envelopes:create" + }, + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeviews/createrecipient/", + "PathName": "EnvelopeViews:createRecipient" + } + ], + "Forms": [ + { + "Inputs": [ { - "RedirectText": "

Prerequisite: Please set the DS_PAYMENT_GATEWAY_ID value in the configuration file.

" - } - ], - "Forms": [ - { - "Inputs": [ - { - "InputName": "Signer Name", - "InputPlaceholder": "Pat Johnson" - }, - { - "InputName": "Signer Email", - "InputPlaceholder": "pat@example.com" - }, - { - "InputName": "CC Name", - "InputPlaceholder": "Pat Johnson" - }, - { - "InputName": "CC Email", - "InputPlaceholder": "pat@example.com" - } - ] + "InputName": "Signer Name", + "InputPlaceholder": "Pat Johnson" } - ], - "ResultsPageText": "The envelope has been created and sent!
Envelope ID {0}." + ] + } + ], + "ResultsPageText": "" + }, + { + "ExampleNumber": 14, + "CFREnabled": "NonCFR", + "ExampleName": "Send an envelope with an order form and payment field", + "ExampleDescription": "Anchor text (AutoPlace) is used to position the fields in the documents.", + "Notes": "
Note: This example will only work if the sender's DocuSign account is set up with a DocuSign payment gateway. Since the Payment Gateway ID is set in the configuration file, you will need to run your own instance of this project to set it.
", + "LinksToAPIMethod": [ + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/", + "PathName": "Envelopes:create" }, { - "ExampleNumber": 39, - "CFREnabled": "NonCFR", - "ExampleName": "Send an envelope to an In Person Signer", - "ExampleDescription": "Demonstrates how to host an In Person Signing session with embedded signing.", - "LinksToAPIMethod": [ + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeviews/createrecipient/", + "PathName": "EnvelopeViews:createRecipient" + } + ], + "RedirectsToOtherCodeExamples": [ + { + "RedirectText": "

Prerequisite: Please set the DS_PAYMENT_GATEWAY_ID value in the configuration file.

" + } + ], + "Forms": [ + { + "Inputs": [ { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/", - "PathName": "Envelopes:create" + "InputName": "Signer Name", + "InputPlaceholder": "Pat Johnson" }, { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeviews/createrecipient/", - "PathName": "EnvelopeViews:createRecipient" - } - ], - "Forms": [ - { - "Inputs": [ - { - "InputName": "Signer Name", - "InputPlaceholder": "Pat Johnson" - } - ] + "InputName": "Signer Email", + "InputPlaceholder": "pat@example.com" + }, + { + "InputName": "CC Name", + "InputPlaceholder": "Pat Johnson" + }, + { + "InputName": "CC Email", + "InputPlaceholder": "pat@example.com" } - ], - "ResultsPageText": "" + ] + } + ], + "ResultsPageText": "The envelope has been created and sent!
Envelope ID {0}." + } + ] + }, + { + "Name": "Using envelopes and templates", + "Examples": [ + { + "ExampleNumber": 4, + "CFREnabled": "AllAccounts", + "ExampleName": "Get an envelope's basic information and status", + "ExampleDescription": "List the basic information about an envelope, including its overall status. Additional API/SDK methods may be used to get additional information about the envelope, its documents, recipients, etc.", + "LinksToAPIMethod": [ + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/get/", + "PathName": "Envelopes:get" + } + ], + "RedirectsToOtherCodeExamples": [ + { + "CodeExampleToRedirectTo": 2, + "RedirectText": "

Problem: please first create an envelope using Send an envelope with a remote (email) signer and cc recipient.
You will then need to use List an envelope's documents to create the list of documents.
Thank you.

" + } + ], + "Forms": [ + { + "FormName": "

The envelope you created via Send an envelope with a remote (email) signer and cc recipient will be queried.

" + } + ], + "ResultsPageText": "Results from the Envelopes::get method:" + }, + { + "ExampleNumber": 5, + "CFREnabled": "AllAccounts", + "ExampleName": "List an envelope's recipients and their status", + "ExampleDescription": "List the envelope's recipients, including their current status.", + "LinksToAPIMethod": [ + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipients/list/", + "PathName": "EnvelopeRecipients:list" + } + ], + "RedirectsToOtherCodeExamples": [ + { + "CodeExampleToRedirectTo": 2, + "RedirectText": "

Problem: please first create an envelope using Send an envelope with a remote (email) signer and cc recipient.
You will then need to use List an envelope's documents to create the list of documents.
Thank you.

" + } + ], + "Forms": [ + { + "FormName": "

The envelope you created via Send an envelope with a remote (email) signer and cc recipient will be queried.

" + } + ], + "ResultsPageText": "" + }, + { + "ExampleNumber": 3, + "CFREnabled": "AllAccounts", + "ExampleName": "List envelopes in the user's account", + "ExampleDescription": "List the envelopes created in the last 30 days.", + "LinksToAPIMethod": [ + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/", + "PathName": "Envelopes:listStatusChanges" + } + ], + "ResultsPageText": "Results from the Envelopes::listStatusChanges method:" + }, + { + "ExampleNumber": 8, + "CFREnabled": "AllAccounts", + "ExampleName": "Create a template", + "ExampleDescription": "Create a template with two roles, signer and cc.", + "LinksToAPIMethod": [ + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/templates/templates/list/", + "PathName": "Templates:list" + }, + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/templates/templates/create/", + "PathName": "Templates:create" + } + ], + "ResultsPageText": "
Template name: {0}, ID {1}." + }, + { + "ExampleNumber": 11, + "CFREnabled": "AllAccounts", + "ExampleName": "Embedded sending", + "ExampleDescription": "An envelope will be created in draft mode. The DocuSign web tool (NDSE) will then be shown, enabling further updates to the envelope before it is sent.", + "LinksToAPIMethod": [ + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/", + "PathName": "Envelopes:create" }, { - "ExampleNumber": 44, - "CFREnabled": "NonCFR", - "ExampleName": "Request a signature using focused view", - "ExampleDescription": "Sends an envelope, then uses focused view for the signer.", - "LinksToAPIMethod": [ + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeviews/createsender/", + "PathName": "EnvelopeViews:createSender" + } + ], + "Forms": [ + { + "Inputs": [ { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/", - "PathName": "Envelopes:create" + "InputName": "Starting View" }, { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeviews/createrecipient/", - "PathName": "EnvelopeViews:createRecipient" - } - ], - "Forms": [ - { - "Inputs": [ - { - "InputName": "Signer Email", - "InputPlaceholder": "pat@example.com" - }, - { - "InputName": "Signer Name", - "InputPlaceholder": "Pat Johnson" - } - ] + "InputName": "Signer Email", + "InputPlaceholder": "pat@example.com" + }, + { + "InputName": "Signer Name", + "InputPlaceholder": "Pat Johnson" + }, + { + "InputName": "CC Email", + "InputPlaceholder": "pat@example.com" + }, + { + "InputName": "CC Name", + "InputPlaceholder": "Pat Johnson" } - ], - "ResultsPageText": "The document has been embedded with focused view.", - "SkipForLanguages": "bash;powershell" + ] + } + ], + "ResultsPageText": "Sender view URL: {0}" + }, + { + "ExampleNumber": 31, + "CFREnabled": "AllAccounts", + "ExampleName": "Bulk send envelopes", + "ExampleDescription": "Demonstrates how to send envelopes in bulk to multiple recipients. First, this example creates a bulk-send recipients list, then creates an envelope. After that, it initiates bulk envelope sending.", + "LinksToAPIMethod": [ + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/bulkenvelopes/bulksend/createbulksendlist/", + "PathName": "BulkSend::createBulkSendList" + }, + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/", + "PathName": "Envelopes::create" + }, + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopecustomfields/create/", + "PathName": "EnvelopeCustomFields::create" }, { - "ExampleNumber": 42, - "CFREnabled": "NonCFR", - "ExampleName": "Request a signature by email with document generation", - "ExampleDescription": "Creates an envelope from a template with a document that is dynamically generated to include all the customized data specified by the sender.", - "LinksToAPIMethod": [ + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/bulkenvelopes/bulksend/createbulksendrequest/", + "PathName": "BulkSend::createBulkSendRequest" + }, + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/bulkenvelopes/bulksend/getbulksendbatchstatus/", + "PathName": "BulkSend::getBulkSendBatchStatus" + } + ], + "CustomErrorTexts": [ + { + "ErrorMessage": "Bulk send envelope failed." + } + ], + "Forms": [ + { + "FormName": "

Bulk copy #1

", + "Inputs": [ + { + "InputName": "Signer Email", + "InputPlaceholder": "Signer Email" + }, { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/templates/templates/create/", - "PathName": "Templates:create" + "InputName": "Signer Name", + "InputPlaceholder": "Signer Name" }, { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/templates/templatedocuments/update/", - "PathName": "TemplateDocuments:update" + "InputName": "CC Email", + "InputPlaceholder": "CC Email" }, { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/templates/templaterecipienttabs/create/", - "PathName": "TemplateRecipientTabs:create" + "InputName": "CC Name", + "InputPlaceholder": "CC Name" + } + ] + }, + { + "FormName": "

Bulk copy #2

", + "Inputs": [ + { + "InputName": "Signer Email", + "InputPlaceholder": "Signer Email" }, { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/", - "PathName": "Envelopes:create" + "InputName": "Signer Name", + "InputPlaceholder": "Signer Name" }, { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/documentgeneration/getenvelopedocgenformfields/", - "PathName": "DocumentGeneration:getEnvelopeDocGenFormFields" + "InputName": "CC Email", + "InputPlaceholder": "CC Email" }, { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/documentgeneration/updateenvelopedocgenformfields/", - "PathName": "DocumentGeneration:updateEnvelopeDocGenFormFields" + "InputName": "CC Name", + "InputPlaceholder": "CC Name" + } + ] + } + ], + "ResultsPageText": "Results from BulkSend:getBulkSendBatchStatus method:" + } + ] + }, + { + "Name": "Using advanced recipient routing", + "Examples": [ + { + "ExampleNumber": 32, + "CFREnabled": "NonCFR", + "ExampleName": "Pause a signature workflow", + "ExampleDescription": "This example creates and envelope and then pauses the signature workflow.", + "LinksToAPIMethod": [ + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/", + "PathName": "Envelopes:create" + } + ], + "Forms": [ + { + "FormName": "

Signer 1

", + "Inputs": [ + { + "InputName": "Signer name", + "InputPlaceholder": "Signer name" }, { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/update/", - "PathName": "Envelopes:update" + "InputName": "Signer Email", + "InputPlaceholder": "Signer Email" } - ], - "Forms": [ - { - "Inputs": [ - { - "InputName": "Candidate Email", - "InputPlaceholder": "pat@example.com" - }, - { - "InputName": "Candidate Name", - "InputPlaceholder": "Pat Johnson" - }, - { - "InputName": "Manager Name", - "InputPlaceholder": "Pat Johnson" - }, - { - "InputName": "Job Title" - }, - { - "InputName": "Salary" - }, - { - "InputName": "Start Date", - "InputPlaceholder": "mm/dd/yyyy" - } - ] + ] + }, + { + "FormName": "

Signer 2

", + "Inputs": [ + { + "InputName": "Signer Email", + "InputPlaceholder": "Signer Email" + }, + { + "InputName": "Signer Name", + "InputPlaceholder": "Signer name" } - ], - "ResultsPageText": "The envelope has been created and sent!
Envelope ID {0}." + ] } - ] + ], + "ResultsPageText": "Results from the Envelopes::create method:" }, { - "Name": "Working with envelopes and templates", - "Examples": [ + "ExampleNumber": 33, + "CFREnabled": "NonCFR", + "ExampleName": "Unpause a signature workflow", + "ExampleDescription": "This example unpauses a signature workflow for the previously created envelope that was paused.", + "LinksToAPIMethod": [ + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/update/", + "PathName": "Envelopes:update" + } + ], + "RedirectsToOtherCodeExamples": [ + { + "CodeExampleToRedirectTo": 32, + "RedirectText": "

Prerequisite: Please first create an envelope with a paused signature workflow using Pause a signature workflow.

" + } + ], + "Forms": [ + { + "FormName": "

Signer 1

", + "Inputs": [ { - "ExampleNumber": 4, - "CFREnabled": "AllAccounts", - "ExampleName": "Get an envelope's basic information and status", - "ExampleDescription": "List the basic information about an envelope, including its overall status. Additional API/SDK methods may be used to get additional information about the envelope, its documents, recipients, etc.", - "LinksToAPIMethod": [ - { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/get/", - "PathName": "Envelopes:get" - } - ], - "RedirectsToOtherCodeExamples": [ - { - "CodeExampleToRedirectTo": 2, - "RedirectText": "

Problem: please first create an envelope using Send an envelope with a remote (email) signer and cc recipient.
You will then need to use List an envelope's documents to create the list of documents.
Thank you.

" - } - ], - "Forms": [ - { - "FormName": "

The envelope you created via Send an envelope with a remote (email) signer and cc recipient will be queried.

" - } - ], - "ResultsPageText": "Results from the Envelopes::get method:" + "InputName": "Signer Email", + "InputPlaceholder": "Signer Email" }, { - "ExampleNumber": 5, - "CFREnabled": "AllAccounts", - "ExampleName": "List an envelope's recipients and their status", - "ExampleDescription": "List the envelope's recipients, including their current status.", - "LinksToAPIMethod": [ - { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipients/list/", - "PathName": "EnvelopeRecipients:list" - } - ], - "RedirectsToOtherCodeExamples": [ - { - "CodeExampleToRedirectTo": 2, - "RedirectText": "

Problem: please first create an envelope using Send an envelope with a remote (email) signer and cc recipient.
You will then need to use List an envelope's documents to create the list of documents.
Thank you.

" - } - ], - "Forms": [ - { - "FormName": "

The envelope you created via Send an envelope with a remote (email) signer and cc recipient will be queried.

" - } - ], - "ResultsPageText": "" + "InputName": "Signer name", + "InputPlaceholder": "Signer name" + } + ] + }, + { + "FormName": "

Conditional signer 2 when unchecked

", + "Inputs": [ + { + "InputName": "Signer Email", + "InputPlaceholder": "Signer Email" }, { - "ExampleNumber": 3, - "CFREnabled": "AllAccounts", - "ExampleName": "List envelopes in the user's account", - "ExampleDescription": "List the envelopes created in the last 30 days.", - "LinksToAPIMethod": [ - { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/", - "PathName": "Envelopes:listStatusChanges" - } - ], - "ResultsPageText": "Results from the Envelopes::listStatusChanges method:" + "InputName": "Signer name", + "InputPlaceholder": "Signer name" + } + ] + }, + { + "FormName": "

Conditional signer 2 when checked

", + "Inputs": [ + { + "InputName": "Signer Email", + "InputPlaceholder": "Signer Email" }, { - "ExampleNumber": 8, - "CFREnabled": "AllAccounts", - "ExampleName": "Create a template", - "ExampleDescription": "Create a template with two roles, signer and cc.", - "LinksToAPIMethod": [ - { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/templates/templates/list/", - "PathName": "Templates:list" - }, - { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/templates/templates/create/", - "PathName": "Templates:create" - } - ], - "ResultsPageText": "
Template name: {0}, ID {1}." + "InputName": "Signer name", + "InputPlaceholder": "Signer name" + } + ] + } + ], + "ResultsPageText": "Results from the Envelopes::update method:" + }, + { + "ExampleNumber": 34, + "CFREnabled": "NonCFR", + "ExampleName": "Use conditional recipients", + "ExampleDescription": "Demonstrates how to create an envelope where the workflow is routed to different recipients based on the value of a transaction.", + "LinksToAPIMethod": [ + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/", + "PathName": "Envelopes:create" + } + ], + "CustomErrorTexts": [ + { + "ErrorMessageCheck": "WORKFLOW_UPDATE_RECIPIENTROUTING_NOT_ALLOWED", + "ErrorMessage": "Update to the workflow with recipient routing is not allowed for your account! Please contact with our support team to resolve this issue." + } + ], + "Forms": [ + { + "FormName": "

Signer 1

", + "Inputs": [ + { + "InputName": "Signer Email", + "InputPlaceholder": "Signer Email" }, { - "ExampleNumber": 11, - "CFREnabled": "AllAccounts", - "ExampleName": "Embedded sending", - "ExampleDescription": "An envelope will be created in draft mode. The DocuSign web tool (NDSE) will then be shown, enabling further updates to the envelope before it is sent.", - "LinksToAPIMethod": [ - { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/", - "PathName": "Envelopes:create" - }, - { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeviews/createsender/", - "PathName": "EnvelopeViews:createSender" - } - ], - "Forms": [ - { - "Inputs": [ - { - "InputName": "Starting View" - }, - { - "InputName": "Signer Email", - "InputPlaceholder": "pat@example.com" - }, - { - "InputName": "Signer Name", - "InputPlaceholder": "Pat Johnson" - }, - { - "InputName": "CC Email", - "InputPlaceholder": "pat@example.com" - }, - { - "InputName": "CC Name", - "InputPlaceholder": "Pat Johnson" - } - ] - } - ], - "ResultsPageText": "Sender view URL: {0}" + "InputName": "Signer name", + "InputPlaceholder": "Signer name" + } + ] + }, + { + "FormName": "

Conditional signer 2 when unchecked

", + "Inputs": [ + { + "InputName": "Signer Email", + "InputPlaceholder": "Signer Email" }, { - "ExampleNumber": 31, - "CFREnabled": "AllAccounts", - "ExampleName": "Bulk send envelopes", - "ExampleDescription": "Demonstrates how to send envelopes in bulk to multiple recipients. First, this example creates a bulk-send recipients list, then creates an envelope. After that, it initiates bulk envelope sending.", - "LinksToAPIMethod": [ - { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/bulkenvelopes/bulksend/createbulksendlist/", - "PathName": "BulkSend::createBulkSendList" - }, - { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/", - "PathName": "Envelopes::create" - }, - { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopecustomfields/create/", - "PathName": "EnvelopeCustomFields::create" - }, - { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/bulkenvelopes/bulksend/createbulksendrequest/", - "PathName": "BulkSend::createBulkSendRequest" - }, - { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/bulkenvelopes/bulksend/getbulksendbatchstatus/", - "PathName": "BulkSend::getBulkSendBatchStatus" - } - ], - "CustomErrorTexts": [ - { - "ErrorMessage": "Bulk send envelope failed." - } - ], - "Forms": [ - { - "FormName": "

Bulk copy #1

", - "Inputs": [ - { - "InputName": "Signer Email", - "InputPlaceholder": "Signer Email" - }, - { - "InputName": "Signer Name", - "InputPlaceholder": "Signer Name" - }, - { - "InputName": "CC Email", - "InputPlaceholder": "CC Email" - }, - { - "InputName": "CC Name", - "InputPlaceholder": "CC Name" - } - ] - }, - { - "FormName": "

Bulk copy #2

", - "Inputs": [ - { - "InputName": "Signer Email", - "InputPlaceholder": "Signer Email" - }, - { - "InputName": "Signer Name", - "InputPlaceholder": "Signer Name" - }, - { - "InputName": "CC Email", - "InputPlaceholder": "CC Email" - }, - { - "InputName": "CC Name", - "InputPlaceholder": "CC Name" - } - ] - } - ], - "ResultsPageText": "Results from BulkSend:getBulkSendBatchStatus method:" + "InputName": "Signer name", + "InputPlaceholder": "Signer name" } - ] + ] + }, + { + "FormName": "

Conditional signer 2 when checked

", + "Inputs": [ + { + "InputName": "Signer Email", + "InputPlaceholder": "Signer Email" + }, + { + "InputName": "Signer name", + "InputPlaceholder": "Signer name" + } + ] + } + ], + "ResultsPageText": "Envelope ID {0} with conditional routing criteria has been created and sent to the first recipient!" }, { - "Name": "Working with advanced recipient routing", - "Examples": [ + "ExampleNumber": 35, + "CFREnabled": "AllAccounts", + "ExampleName": "Schedule an envelope", + "ExampleDescription": "Demonstrates how to schedule an envelope using the scheduled sending feature.", + "LinksToAPIMethod": [ + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/", + "PathName": "Envelopes:create" + } + ], + "Forms": [ + { + "Inputs": [ { - "ExampleNumber": 32, - "CFREnabled": "NonCFR", - "ExampleName": "Pause a signature workflow", - "ExampleDescription": "This example creates and envelope and then pauses the signature workflow.", - "LinksToAPIMethod": [ - { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/", - "PathName": "Envelopes:create" - } - ], - "Forms": [ - { - "FormName": "

Signer 1

", - "Inputs": [ - { - "InputName": "Signer name", - "InputPlaceholder": "Signer name" - }, - { - "InputName": "Signer Email", - "InputPlaceholder": "Signer Email" - } - ] - }, - { - "FormName": "

Signer 2

", - "Inputs": [ - { - "InputName": "Signer Email", - "InputPlaceholder": "Signer Email" - }, - { - "InputName": "Signer Name", - "InputPlaceholder": "Signer name" - } - ] - } - ], - "ResultsPageText": "Results from the Envelopes::create method:" + "InputName": "Signer Email", + "InputPlaceholder": "pat@example.com" }, { - "ExampleNumber": 33, - "CFREnabled": "NonCFR", - "ExampleName": "Unpause a signature workflow", - "ExampleDescription": "This example unpauses a signature workflow for the previously created envelope that was paused.", - "LinksToAPIMethod": [ - { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/update/", - "PathName": "Envelopes:update" - } - ], - "RedirectsToOtherCodeExamples": [ - { - "CodeExampleToRedirectTo": 32, - "RedirectText": "

Prerequisite: Please first create an envelope with a paused signature workflow using Pause a signature workflow.

" - } - ], - "Forms": [ - { - "FormName": "

Signer 1

", - "Inputs": [ - { - "InputName": "Signer Email", - "InputPlaceholder": "Signer Email" - }, - { - "InputName": "Signer name", - "InputPlaceholder": "Signer name" - } - ] - }, - { - "FormName": "

Conditional signer 2 when unchecked

", - "Inputs": [ - { - "InputName": "Signer Email", - "InputPlaceholder": "Signer Email" - }, - { - "InputName": "Signer name", - "InputPlaceholder": "Signer name" - } - ] - }, - { - "FormName": "

Conditional signer 2 when checked

", - "Inputs": [ - { - "InputName": "Signer Email", - "InputPlaceholder": "Signer Email" - }, - { - "InputName": "Signer name", - "InputPlaceholder": "Signer name" - } - ] - } - ], - "ResultsPageText": "Results from the Envelopes::update method:" + "InputName": "Signer Name", + "InputPlaceholder": "Pat Johnson" }, { - "ExampleNumber": 34, - "CFREnabled": "NonCFR", - "ExampleName": "Use conditional recipients", - "ExampleDescription": "Demonstrates how to create an envelope where the workflow is routed to different recipients based on the value of a transaction.", - "LinksToAPIMethod": [ - { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/", - "PathName": "Envelopes:create" - } - ], - "CustomErrorTexts": [ - { - "ErrorMessageCheck": "WORKFLOW_UPDATE_RECIPIENTROUTING_NOT_ALLOWED", - "ErrorMessage": "Update to the workflow with recipient routing is not allowed for your account! Please contact with our support team to resolve this issue." - } - ], - "Forms": [ - { - "FormName": "

Signer 1

", - "Inputs": [ - { - "InputName": "Signer Email", - "InputPlaceholder": "Signer Email" - }, - { - "InputName": "Signer name", - "InputPlaceholder": "Signer name" - } - ] - }, - { - "FormName": "

Conditional signer 2 when unchecked

", - "Inputs": [ - { - "InputName": "Signer Email", - "InputPlaceholder": "Signer Email" - }, - { - "InputName": "Signer name", - "InputPlaceholder": "Signer name" - } - ] - }, - { - "FormName": "

Conditional signer 2 when checked

", - "Inputs": [ - { - "InputName": "Signer Email", - "InputPlaceholder": "Signer Email" - }, - { - "InputName": "Signer name", - "InputPlaceholder": "Signer name" - } - ] - } - ], - "ResultsPageText": "Envelope ID {0} with conditional routing criteria has been created and sent to the first recipient!" + "InputName": "Resume Date" + } + ] + } + ], + "ResultsPageText": "The envelope has been created and scheduled!
Envelope ID {0}." + }, + { + "ExampleNumber": 36, + "CFREnabled": "NonCFR", + "ExampleName": "Send an envelope with delayed routing", + "ExampleDescription": "Demonstrates how to delay an envelope’s delivery between recipients using the delayed routing feature.", + "LinksToAPIMethod": [ + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/", + "PathName": "Envelopes:create" + } + ], + "Forms": [ + { + "Inputs": [ + { + "InputName": "Signer 1 Email", + "InputPlaceholder": "pat@example.com" }, { - "ExampleNumber": 35, - "CFREnabled": "AllAccounts", - "ExampleName": "Schedule an envelope", - "ExampleDescription": "Demonstrates how to schedule an envelope using the scheduled sending feature.", - "LinksToAPIMethod": [ - { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/", - "PathName": "Envelopes:create" - } - ], - "Forms": [ - { - "Inputs": [ - { - "InputName": "Signer Email", - "InputPlaceholder": "pat@example.com" - }, - { - "InputName": "Signer Name", - "InputPlaceholder": "Pat Johnson" - }, - { - "InputName": "Resume Date" - } - ] - } - ], - "ResultsPageText": "The envelope has been created and scheduled!
Envelope ID {0}." + "InputName": "Signer 1 Name", + "InputPlaceholder": "Pat Johnson" }, { - "ExampleNumber": 36, - "CFREnabled": "NonCFR", - "ExampleName": "Send an envelope with delayed routing", - "ExampleDescription": "Demonstrates how to delay an envelope’s delivery between recipients using the delayed routing feature.", - "LinksToAPIMethod": [ - { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/", - "PathName": "Envelopes:create" - } - ], - "Forms": [ - { - "Inputs": [ - { - "InputName": "Signer 1 Email", - "InputPlaceholder": "pat@example.com" - }, - { - "InputName": "Signer 1 Name", - "InputPlaceholder": "Pat Johnson" - }, - { - "InputName": "Signer 2 Email", - "InputPlaceholder": "dana@example.com" - }, - { - "InputName": "Signer 2 Name", - "InputPlaceholder": "Dana Paxon" - }, - { - "InputName": "Delay (in hours)" - } - ] - } - ], - "ResultsPageText": "The envelope has been created and sent!
Envelope ID {0}." + "InputName": "Signer 2 Email", + "InputPlaceholder": "dana@example.com" + }, + { + "InputName": "Signer 2 Name", + "InputPlaceholder": "Dana Paxon" + }, + { + "InputName": "Delay (in hours)" } - ] + ] + } + ], + "ResultsPageText": "The envelope has been created and sent!
Envelope ID {0}." + } + ] + }, + { + "Name": "Using documents", + "Examples": [ + { + "ExampleNumber": 6, + "CFREnabled": "AllAccounts", + "ExampleName": "List an envelope's documents", + "ExampleDescription": "List the envelope's documents. A Certificate of Completion document is also associated with every envelope.", + "LinksToAPIMethod": [ + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopedocuments/list/", + "PathName": "EnvelopeDocuments:list" + } + ], + "RedirectsToOtherCodeExamples": [ + { + "CodeExampleToRedirectTo": 2, + "RedirectText": "

Problem: please first create an envelope using Send an envelope with a remote (email) signer and cc recipient.
You will then need to use List an envelope's documents to create the list of documents.
Thank you.

" + } + ], + "Forms": [ + { + "FormName": "

The envelope you created via Send an envelope with a remote (email) signer and cc recipient will be queried.

" + } + ], + "ResultsPageText": "Results from the EnvelopeDocuments::list method:" }, { - "Name": "Working with documents", - "Examples": [ + "ExampleNumber": 7, + "CFREnabled": "AllAccounts", + "ExampleName": "Download a document from an envelope", + "ExampleDescription": "An envelope's documents can be downloaded one by one or as a complete set.", + "LinksToAPIMethod": [ + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopedocuments/get/", + "PathName": "EnvelopeDocuments:get" + } + ], + "RedirectsToOtherCodeExamples": [ + { + "CodeExampleToRedirectTo": 2, + "RedirectText": "

Problem: please first create an envelope using Send an envelope with a remote (email) signer and cc recipient.
You will then need to use List an envelope's documents to create the list of documents.
Thank you.

" + }, + { + "CodeExampleToRedirectTo": 6, + "RedirectText": "

Problem: please first create a list of the envelope's documents usingList an envelope's documents.
Thank you.

" + } + ], + "Forms": [ + { + "FormName": "

Please choose a document.
The document list is from your results for List an envelope's documents.

", + "Inputs": [ { - "ExampleNumber": 6, - "CFREnabled": "AllAccounts", - "ExampleName": "List an envelope's documents", - "ExampleDescription": "List the envelope's documents. A Certificate of Completion document is also associated with every envelope.", - "LinksToAPIMethod": [ - { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopedocuments/list/", - "PathName": "EnvelopeDocuments:list" - } - ], - "RedirectsToOtherCodeExamples": [ - { - "CodeExampleToRedirectTo": 2, - "RedirectText": "

Problem: please first create an envelope using Send an envelope with a remote (email) signer and cc recipient.
You will then need to use List an envelope's documents to create the list of documents.
Thank you.

" - } - ], - "Forms": [ - { - "FormName": "

The envelope you created via Send an envelope with a remote (email) signer and cc recipient will be queried.

" - } - ], - "ResultsPageText": "Results from the EnvelopeDocuments::list method:" + "InputName": "Document selection" + } + ] + } + ], + "ResultsPageText": "" + }, + { + "ExampleNumber": 10, + "CFREnabled": "AllAccounts", + "ExampleName": "Send an envelope using binary document transfer", + "ExampleDescription": "

The envelope includes a pdf, Word, and HTML document.

Multipart data transfer is used to send the documents in binary format to DocuSign. Binary transfer is 33% more efficient than base64 encoding and is recommended for documents over 15M Bytes. Binary transfer is not yet supported by the SDK.

", + "LinksToAPIMethod": [ + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/", + "PathName": "Envelopes:create" + } + ], + "Forms": [ + { + "Inputs": [ + { + "InputName": "Signer Email", + "InputPlaceholder": "pat@example.com" }, { - "ExampleNumber": 7, - "CFREnabled": "AllAccounts", - "ExampleName": "Download a document from an envelope", - "ExampleDescription": "An envelope's documents can be downloaded one by one or as a complete set.", - "LinksToAPIMethod": [ - { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopedocuments/get/", - "PathName": "EnvelopeDocuments:get" - } - ], - "RedirectsToOtherCodeExamples": [ - { - "CodeExampleToRedirectTo": 2, - "RedirectText": "

Problem: please first create an envelope using Send an envelope with a remote (email) signer and cc recipient.
You will then need to use List an envelope's documents to create the list of documents.
Thank you.

" - }, - { - "CodeExampleToRedirectTo": 6, - "RedirectText": "

Problem: please first create a list of the envelope's documents usingList an envelope's documents.
Thank you.

" - } - ], - "Forms": [ - { - "FormName": "

Please choose a document.
The document list is from your results for List an envelope's documents.

", - "Inputs": [ - { - "InputName": "Document selection" - } - ] - } - ], - "ResultsPageText": "" + "InputName": "Signer Name", + "InputPlaceholder": "Pat Johnson" + }, + { + "InputName": "CC Email", + "InputPlaceholder": "pat@example.com" + }, + { + "InputName": "CC Name", + "InputPlaceholder": "Pat Johnson" + } + ] + } + ], + "ResultsPageText": "The envelope has been created and sent!
Envelope ID {0}." + }, + { + "ExampleNumber": 38, + "CFREnabled": "AllAccounts", + "ExampleName": "Create a signable HTML document", + "ExampleDescription": "Demonstrates how to create an HTML document for responsive signing.", + "LinksToAPIMethod": [ + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/", + "PathName": "Envelopes::create" + }, + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeviews/createrecipient/", + "PathName": "EnvelopeViews:createRecipient" + } + ], + "Forms": [ + { + "Inputs": [ + { + "InputName": "Signer Email", + "InputPlaceholder": "pat@example.com" + }, + { + "InputName": "Signer Name", + "InputPlaceholder": "Pat Johnson" + }, + { + "InputName": "CC Email", + "InputPlaceholder": "pat@example.com" + }, + { + "InputName": "CC Name", + "InputPlaceholder": "Pat Johnson" + } + ] + } + ], + "ResultsPageText": "" + }, + { + "ExampleNumber": 40, + "CFREnabled": "NonCFR", + "ExampleName": "Set document visibility for envelope recipients", + "ExampleDescription": "Demonstrates how to set document visibility for envelope recipients.", + "LinksToAPIMethod": [ + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/", + "PathName": "Envelopes::create" + } + ], + "CustomErrorTexts": [ + { + "ErrorMessageCheck": "ACCOUNT_LACKS_PERMISSIONS", + "ErrorMessage": "See How to set document visibility for envelope recipients in the DocuSign Developer Center for instructions on how to enable document visibility in your developer account." + } + ], + "Forms": [ + { + "Inputs": [ + { + "InputName": "Signer1 Email", + "InputPlaceholder": "pat@example.com" + }, + { + "InputName": "Signer1 Name", + "InputPlaceholder": "Pat Johnson" + }, + { + "InputName": "Signer2 Email", + "InputPlaceholder": "bob@mail.com" + }, + { + "InputName": "Signer2 Name", + "InputPlaceholder": "Bob" + }, + { + "InputName": "CC Email", + "InputPlaceholder": "pat@example.com" + }, + { + "InputName": "CC Name", + "InputPlaceholder": "Pat Johnson" + } + ] + } + ], + "ResultsPageText": "The envelope has been created and sent! Envelope ID {0}." + } + ] + }, + { + "Name": "Using tabs", + "Examples": [ + { + "ExampleNumber": 15, + "CFREnabled": "AllAccounts", + "ExampleName": "Get the tab data from an envelope", + "ExampleDescription": "This example retrieves the tab (field) values from an envelope.", + "LinksToAPIMethod": [ + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeformdata/get/", + "PathName": "EnvelopeFormData:get" + } + ], + "RedirectsToOtherCodeExamples": [ + { + "CodeExampleToRedirectTo": 9, + "RedirectText": "

Prerequisite: Please first create an envelope using Send an envelope using a template.

" + } + ], + "Forms": [ + { + "FormName": "

The last envelope you created with this example launcher will be queried. Recommendation: Use Send an envelope using a template, then this example, since Send an envelope using a template includes many tabs of different types.

" + } + ], + "ResultsPageText": "Results from the Envelopes::get method:" + }, + { + "ExampleNumber": 16, + "CFREnabled": "AllAccounts", + "ExampleName": "Set tab values for a envelope", + "ExampleDescription": "This example sets the tab (field) values for an envelope including tabs that can and cannot be changed by the signer.", + "LinksToAPIMethod": [ + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/", + "PathName": "Envelopes:create" + } + ], + "Forms": [ + { + "Inputs": [ + { + "InputName": "Signer Name", + "InputPlaceholder": "Pat Johnson" + }, + { + "InputName": "Signer Email", + "InputPlaceholder": "pat@example.com" + } + ] + } + ], + "ResultsPageText": "" + }, + { + "ExampleNumber": 17, + "CFREnabled": "AllAccounts", + "ExampleName": "Set template tab values", + "ExampleDescription": "This example sets the tab (field) values for a template being used by an envelope.", + "LinksToAPIMethod": [ + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/", + "PathName": "Envelopes:create" + } + ], + "RedirectsToOtherCodeExamples": [ + { + "CodeExampleToRedirectTo": 8, + "RedirectText": "

Prerequisite: Please first create the template using Create a template.

" + } + ], + "Forms": [ + { + "Inputs": [ + { + "InputName": "Signer Name", + "InputPlaceholder": "Pat Johnson" + }, + { + "InputName": "Signer Email", + "InputPlaceholder": "pat@example.com" + }, + { + "InputName": "CC Name", + "InputPlaceholder": "Pat Johnson" + }, + { + "InputName": "CC Email", + "InputPlaceholder": "pat@example.com" + } + ] + } + ], + "ResultsPageText": "" + }, + { + "ExampleNumber": 18, + "CFREnabled": "AllAccounts", + "ExampleName": "List envelope custom metadata field values", + "ExampleDescription": "This example lists the envelope's custom metadata field values.", + "LinksToAPIMethod": [ + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopecustomfields/list/", + "PathName": "EnvelopeCustomFields:list" + } + ], + "RedirectsToOtherCodeExamples": [ + { + "CodeExampleToRedirectTo": 16, + "RedirectText": "

Problem: Please first create an envelope using Set tab values for a envelope.

" + } + ], + "Forms": [ + { + "FormName": "

The last envelope you created with this example launcher will be queried. Recommendation: Create an envelope using Set tab values for a envelope then use this example in order to see an example of custom tab values.

" + } + ], + "ResultsPageText": "Results from the EnvelopeCustomFields::list method:" + } + ] + }, + { + "Name": "Using brands", + "Examples": [ + { + "ExampleNumber": 28, + "CFREnabled": "AllAccounts", + "ExampleName": "Create a new Brand", + "ExampleDescription": "Create a new Brand", + "LinksToAPIMethod": [ + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accountbrands/create/", + "PathName": "AccountBrands:create" + } + ], + "Forms": [ + { + "FormName": "

New brand

", + "Inputs": [ + { + "InputName": "Brand name", + "InputPlaceholder": "New Brand" }, { - "ExampleNumber": 10, - "CFREnabled": "AllAccounts", - "ExampleName": "Send an envelope using binary document transfer", - "ExampleDescription": "

The envelope includes a pdf, Word, and HTML document.

Multipart data transfer is used to send the documents in binary format to DocuSign. Binary transfer is 33% more efficient than base64 encoding and is recommended for documents over 15M Bytes. Binary transfer is not yet supported by the SDK.

", - "LinksToAPIMethod": [ - { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/", - "PathName": "Envelopes:create" - } - ], - "Forms": [ - { - "Inputs": [ - { - "InputName": "Signer Email", - "InputPlaceholder": "pat@example.com" - }, - { - "InputName": "Signer Name", - "InputPlaceholder": "Pat Johnson" - }, - { - "InputName": "CC Email", - "InputPlaceholder": "pat@example.com" - }, - { - "InputName": "CC Name", - "InputPlaceholder": "Pat Johnson" - } - ] - } - ], - "ResultsPageText": "The envelope has been created and sent!
Envelope ID {0}." + "InputName": "Default Brand language" + } + ] + } + ], + "ResultsPageText": "The brand has been created!
Brand ID: {0}." + }, + { + "ExampleNumber": 29, + "CFREnabled": "AllAccounts", + "ExampleName": "Applying a brand to an envelope", + "ExampleDescription": "Applies brand to an envelope.", + "LinksToAPIMethod": [ + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/", + "PathName": "Envelopes:create" + } + ], + "RedirectsToOtherCodeExamples": [ + { + "CodeExampleToRedirectTo": 28, + "RedirectText": "

No brands were found for this account; please create one first.

" + } + ], + "Forms": [ + { + "Inputs": [ + { + "InputName": "Signer Email", + "InputPlaceholder": "pat@example.com" }, { - "ExampleNumber": 38, - "CFREnabled": "AllAccounts", - "ExampleName": "Create a signable HTML document", - "ExampleDescription": "Demonstrates how to create an HTML document for responsive signing.", - "LinksToAPIMethod": [ - { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/", - "PathName": "Envelopes::create" - }, - { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeviews/createrecipient/", - "PathName": "EnvelopeViews:createRecipient" - } - ], - "Forms": [ - { - "Inputs": [ - { - "InputName": "Signer Email", - "InputPlaceholder": "pat@example.com" - }, - { - "InputName": "Signer Name", - "InputPlaceholder": "Pat Johnson" - }, - { - "InputName": "CC Email", - "InputPlaceholder": "pat@example.com" - }, - { - "InputName": "CC Name", - "InputPlaceholder": "Pat Johnson" - } - ] - } - ], - "ResultsPageText": "" + "InputName": "Signer Name", + "InputPlaceholder": "Pat Johnson" }, { - "ExampleNumber": 40, - "CFREnabled": "NonCFR", - "ExampleName": "Set document visibility for envelope recipients", - "ExampleDescription": "Demonstrates how to set document visibility for envelope recipients.", - "LinksToAPIMethod": [ - { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/", - "PathName": "Envelopes::create" - } - ], - "CustomErrorTexts": [ - { - "ErrorMessageCheck": "ACCOUNT_LACKS_PERMISSIONS", - "ErrorMessage": "See How to set document visibility for envelope recipients in the DocuSign Developer Center for instructions on how to enable document visibility in your developer account." - } - ], - "Forms": [ - { - "Inputs": [ - { - "InputName": "Signer1 Email", - "InputPlaceholder": "pat@example.com" - }, - { - "InputName": "Signer1 Name", - "InputPlaceholder": "Pat Johnson" - }, - { - "InputName": "Signer2 Email", - "InputPlaceholder": "bob@mail.com" - }, - { - "InputName": "Signer2 Name", - "InputPlaceholder": "Bob" - }, - { - "InputName": "CC Email", - "InputPlaceholder": "pat@example.com" - }, - { - "InputName": "CC Name", - "InputPlaceholder": "Pat Johnson" - } - ] - } - ], - "ResultsPageText": "The envelope has been created and sent! Envelope ID {0}." + "InputName": "Brand" } - ] + ] + } + ], + "ResultsPageText": "The envelope has been created and sent!
Envelope ID {0}." }, { - "Name": "Working with tabs", - "Examples": [ + "ExampleNumber": 30, + "CFREnabled": "AllAccounts", + "ExampleName": "Applying a brand to a template", + "ExampleDescription": "Applies brand to a template.", + "LinksToAPIMethod": [ + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/", + "PathName": "Envelopes:create" + } + ], + "RedirectsToOtherCodeExamples": [ + { + "CodeExampleToRedirectTo": 28, + "RedirectText": "

No brands were found for this account; please create one first.

" + }, + { + "CodeExampleToRedirectTo": 8, + "RedirectText": "

Prerequisite: Please first create the template using Create a template.

" + } + ], + "Forms": [ + { + "Inputs": [ { - "ExampleNumber": 15, - "CFREnabled": "AllAccounts", - "ExampleName": "Get the tab data from an envelope", - "ExampleDescription": "This example retrieves the tab (field) values from an envelope.", - "LinksToAPIMethod": [ - { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeformdata/get/", - "PathName": "EnvelopeFormData:get" - } - ], - "RedirectsToOtherCodeExamples": [ - { - "CodeExampleToRedirectTo": 9, - "RedirectText": "

Prerequisite: Please first create an envelope using Send an envelope using a template.

" - } - ], - "Forms": [ - { - "FormName": "

The last envelope you created with this example launcher will be queried. Recommendation: Use Send an envelope using a template, then this example, since Send an envelope using a template includes many tabs of different types.

" - } - ], - "ResultsPageText": "Results from the Envelopes::get method:" + "InputName": "Signer Email", + "InputPlaceholder": "pat@example.com" }, { - "ExampleNumber": 16, - "CFREnabled": "AllAccounts", - "ExampleName": "Set tab values for a envelope", - "ExampleDescription": "This example sets the tab (field) values for an envelope including tabs that can and cannot be changed by the signer.", - "LinksToAPIMethod": [ - { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/", - "PathName": "Envelopes:create" - } - ], - "Forms": [ - { - "Inputs": [ - { - "InputName": "Signer Name", - "InputPlaceholder": "Pat Johnson" - }, - { - "InputName": "Signer Email", - "InputPlaceholder": "pat@example.com" - } - ] - } - ], - "ResultsPageText": "" + "InputName": "Signer Name", + "InputPlaceholder": "Pat Johnson" }, { - "ExampleNumber": 17, - "CFREnabled": "AllAccounts", - "ExampleName": "Set template tab values", - "ExampleDescription": "This example sets the tab (field) values for a template being used by an envelope.", - "LinksToAPIMethod": [ - { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/", - "PathName": "Envelopes:create" - } - ], - "RedirectsToOtherCodeExamples": [ - { - "CodeExampleToRedirectTo": 8, - "RedirectText": "

Prerequisite: Please first create the template using Create a template.

" - } - ], - "Forms": [ - { - "Inputs": [ - { - "InputName": "Signer Name", - "InputPlaceholder": "Pat Johnson" - }, - { - "InputName": "Signer Email", - "InputPlaceholder": "pat@example.com" - }, - { - "InputName": "CC Name", - "InputPlaceholder": "Pat Johnson" - }, - { - "InputName": "CC Email", - "InputPlaceholder": "pat@example.com" - } - ] - } - ], - "ResultsPageText": "" + "InputName": "CC Email", + "InputPlaceholder": "pat@example.com" }, { - "ExampleNumber": 18, - "CFREnabled": "AllAccounts", - "ExampleName": "List envelope custom metadata field values", - "ExampleDescription": "This example lists the envelope's custom metadata field values.", - "LinksToAPIMethod": [ - { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopecustomfields/list/", - "PathName": "EnvelopeCustomFields:list" - } - ], - "RedirectsToOtherCodeExamples": [ - { - "CodeExampleToRedirectTo": 16, - "RedirectText": "

Problem: Please first create an envelope using Set tab values for a envelope.

" - } - ], - "Forms": [ - { - "FormName": "

The last envelope you created with this example launcher will be queried. Recommendation: Create an envelope using Set tab values for a envelope then use this example in order to see an example of custom tab values.

" - } - ], - "ResultsPageText": "Results from the EnvelopeCustomFields::list method:" + "InputName": "CC Name", + "InputPlaceholder": "Pat Johnson" + }, + { + "InputName": "Brand" } - ] + ] + } + ], + "ResultsPageText": "The envelope has been created and sent!
Envelope ID {0}." + } + ] + }, + { + "Name": "Using permissions", + "Examples": [ + { + "ExampleNumber": 24, + "CFREnabled": "AllAccounts", + "ExampleName": "Create a new permission profile", + "ExampleDescription": "Creating new permission profile.", + "LinksToAPIMethod": [ + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accountpermissionprofiles/create/", + "PathName": "AccountPermissionProfiles:create" + } + ], + "Forms": [ + { + "FormName": "

Permission profile

", + "Inputs": [ + { + "InputName": "Profile name", + "InputPlaceholder": "Profile name" + } + ] + } + ], + "ResultsPageText": "The permission profile was created!
Permission profile ID: {0}, name:{1}." }, { - "Name": "Working with brands", - "Examples": [ + "ExampleNumber": 25, + "CFREnabled": "AllAccounts", + "ExampleName": "Setting a permission profile", + "ExampleDescription": "Setting a permission profile.", + "LinksToAPIMethod": [ + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/usergroups/groups/update/", + "PathName": "Groups:update" + } + ], + "CustomErrorTexts": [ + { + "ErrorMessage": "The permission profile failed to set to the user group" + } + ], + "Forms": [ + { + "Inputs": [ { - "ExampleNumber": 28, - "CFREnabled": "AllAccounts", - "ExampleName": "Create a new Brand", - "ExampleDescription": "Create a new Brand", - "LinksToAPIMethod": [ - { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accountbrands/create/", - "PathName": "AccountBrands:create" - } - ], - "Forms": [ - { - "FormName": "

New brand

", - "Inputs": [ - { - "InputName": "Brand name", - "InputPlaceholder": "New Brand" - }, - { - "InputName": "Default Brand language" - } - ] - } - ], - "ResultsPageText": "The brand has been created!
Brand ID: {0}." + "InputName": "Permission profile", + "InputPlaceholder": "Select permission profile" }, { - "ExampleNumber": 29, - "CFREnabled": "AllAccounts", - "ExampleName": "Applying a brand to an envelope", - "ExampleDescription": "Applies brand to an envelope.", - "LinksToAPIMethod": [ - { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/", - "PathName": "Envelopes:create" - } - ], - "RedirectsToOtherCodeExamples": [ - { - "CodeExampleToRedirectTo": 28, - "RedirectText": "

No brands were found for this account; please create one first.

" - } - ], - "Forms": [ - { - "Inputs": [ - { - "InputName": "Signer Email", - "InputPlaceholder": "pat@example.com" - }, - { - "InputName": "Signer Name", - "InputPlaceholder": "Pat Johnson" - }, - { - "InputName": "Brand" - } - ] - } - ], - "ResultsPageText": "The envelope has been created and sent!
Envelope ID {0}." - }, + "InputName": "User group", + "InputPlaceholder": "Select user group" + } + ] + } + ], + "ResultsPageText": "The permission profile was successfully set to the user group!" + }, + { + "ExampleNumber": 26, + "CFREnabled": "AllAccounts", + "ExampleName": "Updating individual permission profile settings", + "ExampleDescription": "Updating individual permissions.", + "LinksToAPIMethod": [ + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accountpermissionprofiles/update/", + "PathName": "AccountPermissionProfiles:update" + } + ], + "Forms": [ + { + "FormName": "

Permission profile

", + "Inputs": [ { - "ExampleNumber": 30, - "CFREnabled": "AllAccounts", - "ExampleName": "Applying a brand to a template", - "ExampleDescription": "Applies brand to a template.", - "LinksToAPIMethod": [ - { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/", - "PathName": "Envelopes:create" - } - ], - "RedirectsToOtherCodeExamples": [ - { - "CodeExampleToRedirectTo": 28, - "RedirectText": "

No brands were found for this account; please create one first.

" - }, - { - "CodeExampleToRedirectTo": 8, - "RedirectText": "

Prerequisite: Please first create the template using Create a template.

" - } - ], - "Forms": [ - { - "Inputs": [ - { - "InputName": "Signer Email", - "InputPlaceholder": "pat@example.com" - }, - { - "InputName": "Signer Name", - "InputPlaceholder": "Pat Johnson" - }, - { - "InputName": "CC Email", - "InputPlaceholder": "pat@example.com" - }, - { - "InputName": "CC Name", - "InputPlaceholder": "Pat Johnson" - }, - { - "InputName": "Brand" - } - ] - } - ], - "ResultsPageText": "The envelope has been created and sent!
Envelope ID {0}." + "InputName": "Profile name", + "InputPlaceholder": "Profile name" + } + ] + } + ], + "ResultsPageText": "The permission profile was updated!
Permission profile ID: {0}." + }, + { + "ExampleNumber": 27, + "CFREnabled": "AllAccounts", + "ExampleName": "Deleting a permission profile", + "ExampleDescription": "Deleting a permission profile", + "Notes": "Note: You cannot remove \"Everyone\" nor \"Administrator\" permission profiles.

", + "LinksToAPIMethod": [ + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accountpermissionprofiles/delete/", + "PathName": "AccountPermissionProfiles:delete" + } + ], + "CustomErrorTexts": [ + { + "ErrorMessage": "The permission profile failed to delete" + } + ], + "Forms": [ + { + "Inputs": [ + { + "InputName": "Permission profile", + "InputPlaceholder": "Select permission profile" } - ] + ] + } + ], + "ResultsPageText": "The permission profile is deleted!" }, { - "Name": "Working with permissions", - "Examples": [ + "ExampleNumber": 43, + "CFREnabled": "AllAccounts", + "ExampleName": "Share access to a DocuSign envelope inbox", + "ExampleDescription": "Share envelope inbox access with an agent user and view the principal user's envelopes using the Shared Access view in the DocuSign UI", + "LinksToAPIMethod": [ + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/users/users/create/", + "PathName": "Users:create" + }, + { + "Path": "", + "PathName": "Users:authorization" + }, + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/liststatus/", + "PathName": "Envelopes:listStatus" + } + ], + "Forms": [ + { + "Inputs": [ { - "ExampleNumber": 24, - "CFREnabled": "AllAccounts", - "ExampleName": "Create a new permission profile", - "ExampleDescription": "Creating new permission profile.", - "LinksToAPIMethod": [ - { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accountpermissionprofiles/create/", - "PathName": "AccountPermissionProfiles:create" - } - ], - "Forms": [ - { - "FormName": "

Permission profile

", - "Inputs": [ - { - "InputName": "Profile name", - "InputPlaceholder": "Profile name" - } - ] - } - ], - "ResultsPageText": "The permission profile was created!
Permission profile ID: {0}, name:{1}." + "InputName": "New Agent Email", + "InputPlaceholder": "pat@example.com" }, { - "ExampleNumber": 25, - "CFREnabled": "AllAccounts", - "ExampleName": "Setting a permission profile", - "ExampleDescription": "Setting a permission profile.", - "LinksToAPIMethod": [ - { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/usergroups/groups/update/", - "PathName": "Groups:update" - } - ], - "CustomErrorTexts": [ - { - "ErrorMessage": "The permission profile failed to set to the user group" - } - ], - "Forms": [ - { - "Inputs": [ - { - "InputName": "Permission profile", - "InputPlaceholder": "Select permission profile" - }, - { - "InputName": "User group", - "InputPlaceholder": "Select user group" - } - ] - } - ], - "ResultsPageText": "The permission profile was successfully set to the user group!" + "InputName": "New Agent Name", + "InputPlaceholder": "Pat Johnson" }, { - "ExampleNumber": 26, - "CFREnabled": "AllAccounts", - "ExampleName": "Updating individual permission profile settings", - "ExampleDescription": "Updating individual permissions.", - "LinksToAPIMethod": [ - { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accountpermissionprofiles/update/", - "PathName": "AccountPermissionProfiles:update" - } - ], - "Forms": [ - { - "FormName": "

Permission profile

", - "Inputs": [ - { - "InputName": "Profile name", - "InputPlaceholder": "Profile name" - } - ] - } - ], - "ResultsPageText": "The permission profile was updated!
Permission profile ID: {0}." + "InputName": "Activation Code", + "InputPlaceholder": "123" + } + ] + } + ], + "ResultsPageText": "Agent has been created. Please go to the agent's email to activate the agent.", + "AdditionalPage": [ + { + "Name": "authenticate_as_agent", + "ResultsPageText": "Please go to the principal's developer account at admindemo.docusign.com and log out, then come back to this page and press continue. You will be redirected to the log in page where you should authenticate as the agent user that you just created." + }, + { + "Name": "list_status_successful", + "ResultsPageText": "

Go to the Manage tab in the agent's DocuSign developer account, select shared access in the upper left, then select the principal's account to view the principal's envelopes. For details, see How to share access to a DocuSign inbox.

Results from Envelopes:listStatus method:

" + }, + { + "Name": "list_status_unsuccessful", + "ResultsPageText": "The principal user's account does not have any envelopes in it. Please log out of the launcher and log in as a principal user and create an envelope." + }, + { + "Name": "user_not_found", + "ResultsPageText": "User has not been activated. Please go to the agent's email to activate the agent." + } + ], + "SkipForLanguages": "java" + } + ] + }, + { + "Name": "Using multi-factor recipient (signer) authentication", + "Examples": [ + { + "ExampleNumber": 23, + "CFREnabled": "AllAccounts", + "ExampleName": "Send an envelope with ID Verification Authentication", + "ExampleDescription": "Submit an envelope that requires verification of a government issued identity.", + "Notes": "

Note: The access code for this example is the Signer Name.

", + "LinksToAPIMethod": [ + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/", + "PathName": "Envelopes:create" + } + ], + "CustomErrorTexts": [ + { + "ErrorMessageCheck": "IDENTITY_WORKFLOW_INVALID_ID", + "ErrorMessage": "Please contact Support to enable IDV in your account." + } + ], + "Forms": [ + { + "Inputs": [ + { + "InputName": "Signer Email", + "InputPlaceholder": "pat@example.com" }, { - "ExampleNumber": 27, - "CFREnabled": "AllAccounts", - "ExampleName": "Deleting a permission profile", - "ExampleDescription": "Deleting a permission profile", - "Notes": "Note: You cannot remove \"Everyone\" nor \"Administrator\" permission profiles.

", - "LinksToAPIMethod": [ - { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accountpermissionprofiles/delete/", - "PathName": "AccountPermissionProfiles:delete" - } - ], - "CustomErrorTexts": [ - { - "ErrorMessage": "The permission profile failed to delete" - } - ], - "Forms": [ - { - "Inputs": [ - { - "InputName": "Permission profile", - "InputPlaceholder": "Select permission profile" - } - ] - } - ], - "ResultsPageText": "The permission profile is deleted!" + "InputName": "Signer Name", + "InputPlaceholder": "Pat Johnson" + } + ] + } + ], + "ResultsPageText": "The envelope has been created and sent!
Envelope ID {0}." + }, + { + "ExampleNumber": 22, + "CFREnabled": "AllAccounts", + "ExampleName": "Send an envelope with Recipient Knowledged Based Authentication", + "ExampleDescription": "Submit an envelope with multiple choice, public records based questions to provide multi-factor authentication.", + "Notes": "

Note: The access code for this example is the Signer Name.

", + "LinksToAPIMethod": [ + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/", + "PathName": "Envelopes:create" + } + ], + "Forms": [ + { + "Inputs": [ + { + "InputName": "Signer Email", + "InputPlaceholder": "pat@example.com" }, { - "ExampleNumber": 43, - "CFREnabled": "AllAccounts", - "ExampleName": "Share access to a DocuSign envelope inbox", - "ExampleDescription": "Share envelope inbox access with an agent user and view the principal user's envelopes using the Shared Access view in the DocuSign UI", - "LinksToAPIMethod": [ - { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/users/users/create/", - "PathName": "Users:create" - }, - { - "Path": "", - "PathName": "Users:authorization" - }, - { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/liststatus/", - "PathName": "Envelopes:listStatus" - } - ], - "Forms": [ - { - "Inputs": [ - { - "InputName": "New Agent Email", - "InputPlaceholder": "pat@example.com" - }, - { - "InputName": "New Agent Name", - "InputPlaceholder": "Pat Johnson" - }, - { - "InputName": "Activation Code", - "InputPlaceholder": "123" - } - ] - } - ], - "ResultsPageText": "Agent has been created. Please go to the agent's email to activate the agent.", - "AdditionalPage": [ - { - "Name": "authenticate_as_agent", - "ResultsPageText": "Please go to the principal's developer account at admindemo.docusign.com and log out, then come back to this page and press continue. You will be redirected to the log in page where you should authenticate as the agent user that you just created." - }, - { - "Name": "list_status_successful", - "ResultsPageText": "

Go to the Manage tab in the agent's DocuSign developer account, select shared access in the upper left, then select the principal's account to view the principal's envelopes. For details, see How to share access to a DocuSign inbox.

Results from Envelopes:listStatus method:

" - }, - { - "Name": "list_status_unsuccessful", - "ResultsPageText": "The principal user's account does not have any envelopes in it. Please log out of the launcher and log in as a principal user and create an envelope." - }, - { - "Name": "user_not_found", - "ResultsPageText": "User has not been activated. Please go to the agent's email to activate the agent." - } - ], - "SkipForLanguages": "java" + "InputName": "Signer Name", + "InputPlaceholder": "Pat Johnson" } - ] + ] + } + ], + "ResultsPageText": "The envelope has been created and sent!
Envelope ID {0}." }, { - "Name": "Implementing multi-factor recipient (signer) authentication", - "Examples": [ + "ExampleNumber": 20, + "CFREnabled": "NonCFR", + "ExampleName": "Require Phone Authentication for a Recipient", + "ExampleDescription": "Sends an envelope that requires entering a six-digit code from a text message or phone call for the purpose of multifactor authentication.", + "LinksToAPIMethod": [ + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/", + "PathName": "Envelopes:create" + } + ], + "CustomErrorTexts": [ + { + "ErrorMessageCheck": "IDENTITY_WORKFLOW_INVALID_ID", + "ErrorMessage": "Please contact Support to enable recipient phone authentication in your account." + } + ], + "Forms": [ + { + "Inputs": [ { - "ExampleNumber": 23, - "CFREnabled": "AllAccounts", - "ExampleName": "Send an envelope with ID Verification Authentication", - "ExampleDescription": "Submit an envelope that requires verification of a government issued identity.", - "Notes": "

Note: The access code for this example is the Signer Name.

", - "LinksToAPIMethod": [ - { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/", - "PathName": "Envelopes:create" - } - ], - "CustomErrorTexts": [ - { - "ErrorMessageCheck": "IDENTITY_WORKFLOW_INVALID_ID", - "ErrorMessage": "Please contact Support to enable IDV in your account." - } - ], - "Forms": [ - { - "Inputs": [ - { - "InputName": "Signer Email", - "InputPlaceholder": "pat@example.com" - }, - { - "InputName": "Signer Name", - "InputPlaceholder": "Pat Johnson" - } - ] - } - ], - "ResultsPageText": "The envelope has been created and sent!
Envelope ID {0}." + "InputName": "Signer Country Code", + "InputPlaceholder": "1" }, { - "ExampleNumber": 22, - "CFREnabled": "AllAccounts", - "ExampleName": "Send an envelope with Recipient Knowledged Based Authentication", - "ExampleDescription": "Submit an envelope with multiple choice, public records based questions to provide multi-factor authentication.", - "Notes": "

Note: The access code for this example is the Signer Name.

", - "LinksToAPIMethod": [ - { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/", - "PathName": "Envelopes:create" - } - ], - "Forms": [ - { - "Inputs": [ - { - "InputName": "Signer Email", - "InputPlaceholder": "pat@example.com" - }, - { - "InputName": "Signer Name", - "InputPlaceholder": "Pat Johnson" - } - ] - } - ], - "ResultsPageText": "The envelope has been created and sent!
Envelope ID {0}." + "InputName": "Signer Phone Number", + "InputPlaceholder": "4155551212" }, { - "ExampleNumber": 20, - "CFREnabled": "NonCFR", - "ExampleName": "Require Phone Authentication for a Recipient", - "ExampleDescription": "Sends an envelope that requires entering a six-digit code from a text message or phone call for the purpose of multifactor authentication.", - "LinksToAPIMethod": [ - { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/", - "PathName": "Envelopes:create" - } - ], - "CustomErrorTexts": [ - { - "ErrorMessageCheck": "IDENTITY_WORKFLOW_INVALID_ID", - "ErrorMessage": "Please contact Support to enable recipient phone authentication in your account." - } - ], - "Forms": [ - { - "Inputs": [ - { - "InputName": "Signer Country Code", - "InputPlaceholder": "1" - }, - { - "InputName": "Signer Phone Number", - "InputPlaceholder": "4155551212" - }, - { - "InputName": "Signer Email", - "InputPlaceholder": "pat@example.com" - }, - { - "InputName": "Signer Name", - "InputPlaceholder": "Pat Johnson" - } - ] - } - ], - "ResultsPageText": "The envelope has been created and sent!
Envelope ID {0}." + "InputName": "Signer Email", + "InputPlaceholder": "pat@example.com" }, { - "ExampleNumber": 19, - "CFREnabled": "AllAccounts", - "ExampleName": "Send an envelope with Access Code Recipient Authentication", - "ExampleDescription": "Submit an envelope with an access code for multi-factor authentication.", - "LinksToAPIMethod": [ - { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/", - "PathName": "Envelopes:create" - } - ], - "Forms": [ - { - "Inputs": [ - { - "InputName": "Access Code", - "InputPlaceholder": "Enter a recipient access code here" - }, - { - "InputName": "Signer Email", - "InputPlaceholder": "pat@example.com" - }, - { - "InputName": "Signer Name", - "InputPlaceholder": "Pat Johnson" - } - ] - } - ], - "ResultsPageText": "The envelope has been created and sent!
Envelope ID {0}." + "InputName": "Signer Name", + "InputPlaceholder": "Pat Johnson" } - ] + ] + } + ], + "ResultsPageText": "The envelope has been created and sent!
Envelope ID {0}." }, { - "Name": "Embedded DocuSign web tool", - "Examples": [ + "ExampleNumber": 19, + "CFREnabled": "AllAccounts", + "ExampleName": "Send an envelope with Access Code Recipient Authentication", + "ExampleDescription": "Submit an envelope with an access code for multi-factor authentication.", + "LinksToAPIMethod": [ + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/", + "PathName": "Envelopes:create" + } + ], + "Forms": [ + { + "Inputs": [ { - "ExampleNumber": 12, - "CFREnabled": "AllAccounts", - "ExampleName": "Embedded DocuSign web tool", - "ExampleDescription": "Redirect the user to the DocuSign web tool.", - "LinksToAPIMethod": [ - { - "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeviews/createconsole/", - "PathName": "EnvelopeViews:createConsole" - } - ], - "RedirectsToOtherCodeExamples": [ - { - "CodeExampleToRedirectTo": 2, - "RedirectText": "

Optional: To use the envelope's Documents view, please first create an envelope using Send an envelope with a remote (email) signer and cc recipient.

" - } - ], - "Forms": [ - { - "Inputs": [ - { - "InputName": "Starting View" - } - ] - } - ], - "ResultsPageText": "NDSE view URL: {0}." + "InputName": "Access Code", + "InputPlaceholder": "Enter a recipient access code here" + }, + { + "InputName": "Signer Email", + "InputPlaceholder": "pat@example.com" + }, + { + "InputName": "Signer Name", + "InputPlaceholder": "Pat Johnson" } - ] + ] + } + ], + "ResultsPageText": "The envelope has been created and sent!
Envelope ID {0}." } - ] + ] + }, + { + "Name": "Embedded DocuSign web tool", + "Examples": [ + { + "ExampleNumber": 12, + "CFREnabled": "AllAccounts", + "ExampleName": "Embedded DocuSign web tool", + "ExampleDescription": "Redirect the user to the DocuSign web tool.", + "LinksToAPIMethod": [ + { + "Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeviews/createconsole/", + "PathName": "EnvelopeViews:createConsole" + } + ], + "RedirectsToOtherCodeExamples": [ + { + "CodeExampleToRedirectTo": 2, + "RedirectText": "

Optional: To use the envelope's Documents view, please first create an envelope using Send an envelope with a remote (email) signer and cc recipient.

" + } + ], + "Forms": [ + { + "Inputs": [ + { + "InputName": "Starting View" + } + ] + } + ], + "ResultsPageText": "NDSE view URL: {0}." + } + ] + } + ] }, { "Name": "Click", @@ -2612,7 +2617,7 @@ } ], "ResultsPageText": "This value should match the value of your x-docusign-signature header:
HMAC signature {0}", - "SkipForLanguages": "bash;powershell" + "SkipForLanguages": "bash;powershell;java;php" } ] }