Templates: rotateDocumentPage

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

Request

HTTP request

PUT /v2/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/page_image

Parameters

Parameter name Value Description
Path parameters
accountId string

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

documentId string

The ID of the document being accessed.

pageNumber string

The page number being accessed.

templateId string

The ID of the template being accessed.

Request Body

Responses

Code Description Reference
200 OK Successful response.
400 Bad Request Error encountered.

SDK Method

Templates::rotateDocumentPage

Definitions Expand All | Collapse All

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.

pageRequest

password string
rotate string

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>