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 name Value Description
Path parameters
accountId string

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

imageType string

One of signature_image or initials_image.

signatureId string

The ID of the signature being accessed.

userId string

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

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

SDK Method

Users::updateSignatureImage

Definitions Expand All | Collapse All

UserSignatures

Users' signatures

adoptedDateTime string

The date and time the user adopted their signature.

createdDateTime string

Indicates the date and time the item was created.

dateStampProperties dateStampProperties
errorDetails errorDetails
externalID string
imageType string

One of signature_image or initials_image.

initials150ImageId string
initialsImageUri string

Contains the URI for an endpoint that you can use to retrieve the initials image.

isDefault string
phoneticName string
signature150ImageId string
signatureFont string

The font type for the signature, if the signature is not drawn. The supported font types are:

"7_DocuSign", "1_DocuSign", "6_DocuSign", "8_DocuSign", "3_DocuSign", "Mistral", "4_DocuSign", "2_DocuSign", "5_DocuSign", "Rage Italic"

signatureId string

Specifies the signature ID associated with the signature name. You can use the signature ID in the URI in place of the signature name, and the value stored in the signatureName property in the body is used. This allows the use of special characters (such as "&", "<", ">") in a the signature name. Note that with each update to signatures, the returned signature ID might change, so the caller will need to trigger off the signature name to get the new signature ID.

signatureImageUri string

Contains the URI for an endpoint that you can use to retrieve the signature image.

signatureInitials string

The initials associated with the signature.

signatureName string

Specifies the user signature name.

signatureType string
stampFormat string
stampImageUri string
stampSizeMM string
stampType string

dateStampProperties

dateAreaHeight string
dateAreaWidth string
dateAreaX string
dateAreaY string

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.

Examples

Generic JSON Response

Response

{
"signatureId": "sample string 1",
"stampType": "sample string 2",
"phoneticName": "sample string 3",
"imageType": "sample string 4",
"externalID": "sample string 5",
"stampSizeMM": "sample string 6",
"stampFormat": "sample string 7",
"dateStampProperties": {
"dateAreaX": "sample string 1",
"dateAreaY": "sample string 2",
"dateAreaWidth": "sample string 3",
"dateAreaHeight": "sample string 4"
}
,
"stampImageUri": "sample string 8",
"signatureFont": "sample string 9",
"signatureType": "sample string 10",
"signatureName": "sample string 11",
"signatureImageUri": "sample string 12",
"signatureInitials": "sample string 13",
"initialsImageUri": "sample string 14",
"createdDateTime": "sample string 15",
"adoptedDateTime": "sample string 16",
"signature150ImageId": "sample string 17",
"initials150ImageId": "sample string 18",
"isDefault": "sample string 19",
"errorDetails": {
"errorCode": "sample string 1",
"message": "sample string 2"
}
}

Generic XML Response

Response

<userSignature 
xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.docusign.com/restapi">

<adoptedDateTime>sample string 16</adoptedDateTime>
<createdDateTime>sample string 15</createdDateTime>
<dateStampProperties>
<dateAreaHeight>sample string 4</dateAreaHeight>
<dateAreaWidth>sample string 3</dateAreaWidth>
<dateAreaX>sample string 1</dateAreaX>
<dateAreaY>sample string 2</dateAreaY>
</dateStampProperties>
<errorDetails>
<errorCode>sample string 1</errorCode>
<message>sample string 2</message>
</errorDetails>
<externalID>sample string 5</externalID>
<imageType>sample string 4</imageType>
<initials150ImageId>sample string 18</initials150ImageId>
<initialsImageUri>sample string 14</initialsImageUri>
<isDefault>sample string 19</isDefault>
<phoneticName>sample string 3</phoneticName>
<signature150ImageId>sample string 17</signature150ImageId>
<signatureFont>sample string 9</signatureFont>
<signatureId>sample string 1</signatureId>
<signatureImageUri>sample string 12</signatureImageUri>
<signatureInitials>sample string 13</signatureInitials>
<signatureName>sample string 11</signatureName>
<signatureType>sample string 10</signatureType>
<stampFormat>sample string 7</stampFormat>
<stampImageUri>sample string 8</stampImageUri>
<stampSizeMM>sample string 6</stampSizeMM>
<stampType>sample string 2</stampType>
</userSignature>