DocuSign Momentum 2018DocuSign Momentum 2018

UserSignatures: updateImage

Updates the user signature image or user initials image for the specified user. The supported image formats for this file are: gif, png, jpeg, and bmp. The file must be less than 200K.

The userId property specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.

The signatureId parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (signatureId), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint.

For example encode "Bob Smith" as "Bob%20Smith".

Request

HTTP request

PUT /v2/accounts/{accountId}/users/{userId}/signatures/{signatureId}/{imageType}

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

imageTypestring

One of signature_image or initials_image.

signatureIdstring

The ID of the signature being accessed.

userIdstring

The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

Responses

CodeDescriptionReference
200

Successful response.

UserSignatures
400

Error encountered.

errorDetails

SDK Method

Users::updateSignatureImage

Definitions

dateStampProperties
errorDetails
UserSignatures

Examples

Generic JSON Response
Generic XML Response