TemplateViews: createEdit

This method returns a URL for starting an edit view of a template that uses the DocuSign Template UI.

Request

HTTP request

POST /v2.1/accounts/{accountId}/templates/{templateId}/views/edit

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

The external account number (int) or account ID GUID.

templateIdstring

The id of the template.

Request Body

returnUrlRequest

Responses

CodeDescriptionReference
201

Successful response.

TemplateViews
400

Error encountered.

errorDetails

SDK Method

Templates::createEditView

Definitions

errorDetails

This object describes errors that occur. It is only valid for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

returnUrlRequest

The request body for the EnvelopeViews::createSender method.

returnUrlstring

(Optional) The URL to which the user should be redirected after the sending session is complete.

Maximum Length: 500 characters. If the returnUrl exceeds this limit, the user is redirected to a truncated URL.

TemplateViews

A TemplateView contains a URL that you can embed in your application to generate a template view that uses the DocuSign user interface (UI).

urlstring

The URL that you navigate to in order to start the view.

Examples

Generic JSON Request/Response

Request
{
  "returnUrl": "sample string 1"
}
Response
{
  "url": "sample string 1"
}
Generic XML Request/Response

Request
<returnUrlRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <returnUrl>sample string 1</returnUrl>
</returnUrlRequest> 
Response
<viewUrl xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <url>sample string 1</url>
</viewUrl> 
}} />