Envelopes: rotateDocumentPage

Rotates page image from an envelope for display. The page image can be rotated to the left or right.

Request

HTTP request

PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/page_image

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

documentIdstring

The documentId is set by the API client. It is an integer that falls between 1 and 2,147,483,647. The value is encoded as a string without commas. The values 1, 2, 3, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a documentId property that specifies the document on which to place the tab.

envelopeIdstring

The envelope's GUID.

Example: 93be49ab-afa0-4adf-933c-f752070d71ec

pageNumberstring

The page number being accessed.

Request Body

pageRequest

Responses

CodeDescriptionReference
200

Successful response.

400

Error encountered.

errorDetails

SDK Method

Envelopes::rotateDocumentPage

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.

pageRequest

passwordstring

The user's encrypted password hash.

rotatestring

Sets the direction the page image is rotated. The possible settings are: left or right

Examples

Generic JSON Request

Request
{
  "rotate": "sample string 1",
  "password": "sample string 2"
}
Generic XML Request

Request
<pageRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <password>sample string 2</password>
  <rotate>sample string 1</rotate>
</pageRequest> 
}} />