User Signatures

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

DELETE
/v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}/{imageType}

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".

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.

imageType*string

Specificies the type of image. Valid values:

  • stamp_image
  • signature_image
  • initials_image
signatureId*string

The ID of the account stamp.

userId*string

The ID of the user to access.

Note: Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.

Response Body

application/json

application/json

curl -X DELETE "https://example.com/v2.1/accounts/string/users/string/signatures/string/string"
{  "adoptedDateTime": "string",  "createdDateTime": "string",  "customField": "string",  "dateStampProperties": {    "dateAreaHeight": "string",    "dateAreaWidth": "string",    "dateAreaX": "string",    "dateAreaY": "string"  },  "disallowUserResizeStamp": "string",  "errorDetails": {    "errorCode": "string",    "message": "string"  },  "externalID": "string",  "imageBase64": "string",  "imageType": "string",  "initials150ImageId": "string",  "initialsImageUri": "string",  "isDefault": "string",  "lastModifiedDateTime": "string",  "nrdsId": "string",  "nrdsLastName": "string",  "nrdsStatus": "string",  "phoneticName": "string",  "signature150ImageId": "string",  "signatureFont": "string",  "signatureId": "string",  "signatureImageUri": "string",  "signatureInitials": "string",  "signatureName": "string",  "signatureRights": "string",  "signatureType": "string",  "stampFormat": "string",  "stampImageUri": "string",  "stampSizeMM": "string",  "stampType": "string",  "status": "string"}

Retrieves the user initials image or the user signature image for the specified user GET

Retrieves the specified initials image or signature image for the specified user. The image is returned in the same format in which it was uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. 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". **Note:** Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image.

Updates the user signature image or user initials image for the specified user PUT

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".