TemplateViews: createEdit

Request

HTTP request

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

Parameters

Parameter name Value Description
Path parameters
accountId string

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

templateId string

The ID of the template being accessed.

Request Body

Responses

Code Description Reference
201 Created Successful response.
400 Bad Request Error encountered.

SDK Method

Templates::createEditView

Definitions Expand All | Collapse All

TemplateViews

Embedding template views

url string

The view URL to be navigated to.

errorDetails

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

errorCode string

An error code associated with the error.

message string

A short error message.

returnUrlRequest

The request body for the EnvelopeViews: createSender method.

returnUrl string

Your app's return url that the user will be redirected to after sending the envelope or completing the sending/tagging view. Query parameters envelopeId and event will be added to the URL. The event parameter values:

  • Send (the user sent the envelope)
  • Save (the user saved the envelope, it is still a draft)
  • Cancel (the user canceled the sending transaction)
  • Error (there was an error during the send operation)
  • SessionEnd (the sending session ended before the user completed a different action)

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>