Sign in

v1

latestSwagger 2.02026-07-134146194.6 MB
UserSignatures

Updates the user signature for a specified user.

Creates, or updates, the signature font and initials for the specified user. When creating a signature, you use this resource to create the signature name and then add the signature and initials images into the signature.

Note: This will also create a default signature for the user when one does not exist.

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

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

Path parameters

accountIdstring required

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

signatureIdstring required

The ID of the account stamp.

userIdstring required

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.

Query parameters

close_existing_signaturestring

When true, closes the current signature.

Request body

disallowUserResizeStampstring

When true, users may not resize the stamp.

externalIDstring

Optionally specify an external identifier for the user's signature.

imageTypestring

Specificies the type of image. Valid values:

  • stamp_image
  • signature_image
  • initials_image
isDefaultstring

Boolean that specifies whether the signature is the default signature for the user.

nrdsIdstring

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

nrdsLastNamestring

The realtor's last name.

phoneticNamestring

The phonetic spelling of the signatureName.

signatureFontstring

The font type to use for the signature if the signature is not drawn. The following font styles are supported. The quotes are to indicate that these values are strings, not enums.

  • "1_DocuSign"
  • "2_DocuSign"
  • "3_DocuSign"
  • "4_DocuSign"
  • "5_DocuSign"
  • "6_DocuSign"
  • "7_DocuSign"
  • "8_DocuSign"
  • "Mistral"
  • "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.

signatureInitialsstring

Specifies the user's signature in initials format.

signatureNamestring

Specifies the user's signature name.

signatureTypestring

Specifies the type of signature.

stampFormatstring

The format of a stamp. Valid values are:

  • NameHanko: The stamp represents only the signer's name.
  • NameDateHanko: The stamp represents the signer's name and the date.
stampSizeMMstring

The physical height of the stamp image (in millimeters) that the stamp vendor recommends for displaying the image in PDF documents.

Response

Successful response.