Envelopes

Rotates page image from an envelope for display

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

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

Authorization

OAuth2
AuthorizationBearer <token>

OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.

In: header

Path Parameters

accountId*string

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

documentId*string

The unique ID of the document within the envelope.

Unlike other IDs in the eSignature API, you specify the documentId yourself. Typically the first document has the ID 1, the second document 2, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647).

Tab objects have a documentId property that specifies the document on which to place the tab.

envelopeId*string

The envelope's GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

pageNumber*string

The page number being accessed.

Request Body

application/json

password?string

The user's password.

This property is used only when adding a new user via a Users: create request. The value must conform to the password rules defined in the account Security Settings.

This property is not returned by GET requests and cannot be updated via PUT requests.

rotate?string

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

Response Body

application/json

curl -X PUT "https://example.com/v2.1/accounts/string/envelopes/string/documents/string/pages/string/page_image" \  -H "Content-Type: application/json" \  -d '{}'
Empty