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/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 ID of the document being accessed.

envelopeIdstring

The envelope's GUID. Eg 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

An error code associated with the error.

messagestring

A short error message.

pageRequest

passwordstring

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> 
}} />