UserSignatures: deleteImage

Deletes the specified initials image or signature image for the specified user.

The function deletes one or the other of the image types, to delete both the initials image and signature image you must call the endpoint twice.

The userId parameter 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

DELETE /v2.1/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 Administrator on the account, this can be another user the Admin user is accessing. Note: For Envelopes:listStatusChanges (GET /v2.1/accounts/{accountId}/envelopes), the user_id query parameter is not implemented and should not be used.

Responses

CodeDescriptionReference
200

Successful response.

UserSignatures
400

Error encountered.

errorDetails

SDK Method

Users::deleteSignatureImage

Definitions

dateStampProperties

dateAreaHeightstring

dateAreaWidthstring

dateAreaXstring

dateAreaYstring

errorDetails

This object describes errors that occur. It is only valid for responses, and ignored in requests.

errorCodestring

A code associated with the error condition.

messagestring

A brief message describing the error condition.

UserSignatures

Users' signatures

adoptedDateTimestring

The date and time the user adopted their signature.

createdDateTimestring

The date and time the item was created.

customFieldstring

Serialized information about custom eHanko stamps that have been ordered, including the order status, purchase order id, time created, and time modified.

dateStampPropertiesdateStampProperties

disallowUserResizeStampstring

When set to true, the user may not resize the stamp.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; ignored in requests.

externalIDstring

May contain an external identifier for the user's signature.

imageBase64string

The base64-encoded bytes of the signature image.

imageTypestring

One of signature_image or initials_image.

initials150ImageIdstring

The id of the image of the user's initials.

initialsImageUristring

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

isDefaultstring

When set to true, indicates that the signature is the default signature for the user.

lastModifiedDateTimestring

The date and time the item was last modified.

nrdsIdstring

The National Association of Realtors (NAR) membership id for a user who is a realtor.

nrdsLastNamestring

The realtor's last name.

nrdsStatusstring

The realtor's NAR membership status. The value active verifies that the user is a current NAR member. Potential values are:

  • Active
  • Inactive
  • Terminate
  • Provisional
  • Deceased
  • Suspend
  • Unknown

phoneticNamestring

The phonetic spelling of the signatureName.

signature150ImageIdstring

The id of the image of the user's signature.

signatureFontstring

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"

signatureIdstring

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.

signatureImageUristring

An endpoint URI that you can use to retrieve the user's signature image.

signatureInitialsstring

The initials associated with the signature.

signatureNamestring

Specifies the user signature name.

signatureRightsstring

The rights that the user has to the signature. Valid values are:

  • none
  • read
  • admin

signatureTypestring

Specifies the type of signature.

stampFormatstring

stampImageUristring

The URL for retrieving the image of the user's stamp.

stampSizeMMstring

stampTypestring

If the recipient signs by using a personal stamp that is representative of their signature, this property specifies the stamp type.

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