{ "opencollection": "1.0.0", "info": { "name": "DocuSign Admin AccountBrands EnvelopeViews API", "version": "v2.1" }, "items": [ { "info": { "name": "EnvelopeViews", "type": "folder" }, "items": [ { "info": { "name": "Docusign Create an Embedded Recipient Signing View", "type": "http" }, "http": { "method": "POST", "url": "https://api.docusign.net/Management/accounts/:accountId/envelopes/:envelopeId/views/recipient", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The external account number (short) or account ID GUID of the DocuSign account." }, { "name": "envelopeId", "value": "", "type": "path", "description": "The envelope ID (GUID) of the envelope." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Generates a URL that enables an embedded recipient to sign an envelope within your application. The URL is time-limited and intended for immediate use." }, { "info": { "name": "Docusign Create an Embedded Sender View", "type": "http" }, "http": { "method": "POST", "url": "https://api.docusign.net/Management/accounts/:accountId/envelopes/:envelopeId/views/sender", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The external account number (short) or account ID GUID of the DocuSign account." }, { "name": "envelopeId", "value": "", "type": "path", "description": "The envelope ID (GUID) of the envelope." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Generates a URL that enables an embedded sender to edit an envelope in draft status before sending it." }, { "info": { "name": "Docusign Returns a URL to the envelope correction UI.", "type": "http" }, "http": { "method": "POST", "url": "https://api.docusign.net/Management/v2/accounts/:accountId/envelopes/:envelopeId/views/correct", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The external account number (int) or account id GUID." }, { "name": "envelopeId", "value": "", "type": "path", "description": "The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec " } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns a URL that allows you to embed the envelope correction view of the DocuSign UI in your applications.\n\nImportant: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. " }, { "info": { "name": "Views_DeleteEnvelopeCorrectView", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.docusign.net/Management/v2/accounts/:accountId/envelopes/:envelopeId/views/correct", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The external account number (int) or account id GUID." }, { "name": "envelopeId", "value": "", "type": "path", "description": "The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec " } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "Docusign Returns a URL to the edit view UI.", "type": "http" }, "http": { "method": "POST", "url": "https://api.docusign.net/Management/v2/accounts/:accountId/envelopes/:envelopeId/views/edit", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The external account number (int) or account id GUID." }, { "name": "envelopeId", "value": "", "type": "path", "description": "The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec " } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns a URL that allows you to embed the edit view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign editing view. \n\nUpon sending completion, the user is returned to the return URL provided by the API application.\n\nImportant: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. " }, { "info": { "name": "Docusign Returns a URL to the recipient view UI.", "type": "http" }, "http": { "method": "POST", "url": "https://api.docusign.net/Management/v2/accounts/:accountId/envelopes/:envelopeId/views/recipient", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The external account number (int) or account id GUID." }, { "name": "envelopeId", "value": "", "type": "path", "description": "The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec " } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns a URL that enables you to embed the recipient view of the DocuSign UI in your applications. If the recipient is a signer, then the view will provide the signing ceremony.\n\n###### Note: Please redirect the client to the URL. iFrames should not be used, especially if the recipient is using a mobile or tablet. \n\nThis method is only used with envelopes in the `sent` status.\n\nYour application is responsible for authenticating the identity of the recipient or signer when you use this method. U" }, { "info": { "name": "Docusign Returns a URL to the sender view UI.", "type": "http" }, "http": { "method": "POST", "url": "https://api.docusign.net/Management/v2/accounts/:accountId/envelopes/:envelopeId/views/sender", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The external account number (int) or account id GUID." }, { "name": "envelopeId", "value": "", "type": "path", "description": "The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec " } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns a URL that enables you to embed the sender view of the DocuSign UI in your applications.\n\nThe returned URL can only be redirected to immediately after it is generated. It can only be used once.\nTherefore, request the URL immediately before you redirect your user to it.\n\nFor the best user experience, don't use an iFrame. For iOS devices DocuSign recommends using a WebView.\n\nMultiple solutions are available for maintaining your\nclient state. See the **Maintaining State** section of the [Em" }, { "info": { "name": "Views_PostEnvelopeRecipientSharedView", "type": "http" }, "http": { "method": "POST", "url": "https://api.docusign.net/Management/v2/accounts/:accountId/envelopes/:envelopeId/views/shared", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The external account number (int) or account id GUID." }, { "name": "envelopeId", "value": "", "type": "path", "description": "The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec " } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "Docusign Returns a URL to the authentication view UI.", "type": "http" }, "http": { "method": "POST", "url": "https://api.docusign.net/Management/v2/accounts/:accountId/views/console", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The external account number (int) or account id GUID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns a URL that allows you to embed the authentication view of the DocuSign UI in your applications." } ] } ], "bundled": true }