Skip to content

DocuSign: Updates the user signature for a specified user

DocuSign esignature.esignatureUserSignaturesPutUserSignatureById: arguments, response, policy and SDK examples.

← Esignature operations · Get started

Operation docusign.esignature_usersignatures_putusersignaturebyid

Provider route: PUT /restapi/v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/docusign with npm, or alter-sdk-docusign with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DocuSignIntegration } from "@alter-ai/docusign";
async function execute(input: Parameters<DocuSignIntegration["esignature"]["esignatureUserSignaturesPutUserSignatureById"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new DocuSignIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.esignature.esignatureUserSignaturesPutUserSignatureById(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_docusign import DocuSignIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = DocuSignIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.esignature.esignature_user_signatures_put_user_signature_by_id(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.accountIdstringRequired within parent
path.signatureIdstringRequired within parent
path.userIdstringRequired within parent
queryobjectOptionalAdditional keys: not allowed
query.close_existing_signaturestringOptional
bodyModelOptionalExpand Updates the user signature for a specified user — request body — body

Referenced models: Updates the user signature for a specified user — request body — body

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Updates the user signature for a specified user — response body

Referenced models: Updates the user signature for a specified user — response body

Updates the user signature for a specified user — response body
FieldTypePresenceDescription and constraints
$objectRoot
adoptedDateTimestringOptionalThe date and time the user adopted their signature.
createdDateTimestringOptionalThe UTC DateTime when the item was created.
customFieldstringOptional
dateStampPropertiesModelOptionalExpand Deletes the image for a stamp — response body — date Stamp Properties
Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area.

This property contains the following information about the central rectangle:

- `DateAreaX`: The X axis position of the top-left corner.
- `DateAreaY`: The Y axis position of the top-left corner.
- `DateAreaWidth`: The width of the rectangle.
- `DateAreaHeight`: The height of the rectangle.
disallowUserResizeStampstringOptionalWhen **true,** users may not resize the stamp.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
externalIDstringOptionalOptionally specify an external identifier for the user's signature.
imageBase64stringOptionalA Base64-encoded representation of the signature image.
imageTypestringOptionalSpecificies the type of image. Valid values:

- `stamp_image`
- `signature_image`
- `initials_image`
initials150ImageIdstringOptionalThe ID of the user's initials image.
initialsImageUristringOptionalThe URI for retrieving the image of the user's initials.
isDefaultstringOptionalBoolean that specifies whether the signature is the default signature for the user.
lastModifiedDateTimestringOptionalThe date and time that the item was last modified.
nrdsIdstringOptionalThe National Association of Realtors (NAR) membership ID for a user who is a realtor.
nrdsLastNamestringOptionalThe realtor's last name.
nrdsStatusstringOptionalThe realtor's NAR membership status. The value `active` verifies that the user is a current NAR member. Valid values are:

- `Active`
- `Inactive`
- `Terminate`
- `Provisional`
- `Deceased`
- `Suspend`
- `Unknown`
phoneticNamestringOptionalThe phonetic spelling of the `signatureName`.
signature150ImageIdstringOptionalThe ID of the user's signature image.
signatureFontstringOptionalThe 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"
signatureIdstringOptionalSpecifies 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.
signatureImageUristringOptionalAn endpoint URI that you can use to retrieve the user's signature image.
signatureInitialsstringOptionalThe initials associated with the signature.
signatureNamestringOptionalSpecifies the user's signature name.
signatureRightsstringOptionalThe rights that the user has to the signature. Valid values are:

- `none`
- `read`
- `admin`
signatureTypestringOptionalSpecifies the type of signature.
stampFormatstringOptionalThe 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.
stampImageUristringOptionalThe URI for retrieving the image of the user's stamp.
stampSizeMMstringOptionalThe physical height of the stamp image (in millimeters) that the stamp vendor recommends for displaying the image in PDF documents.
stampTypestringOptionalThe type of stamp. Valid values are:

- `signature`: A signature image. This is the default value.
- `stamp`: A stamp image.
- null
statusstringOptionalIndicates the envelope status. Valid values are:

* sent - The envelope is sent to the recipients.
* created - The envelope is saved as a draft and can be modified and sent later.

Referenced models: Deletes the image for a stamp — response body — date Stamp Properties, Locks a template — response body — error Details

Updates the user signature for a specified user — request body — body
FieldTypePresenceDescription and constraints
$objectRoot
dateStampPropertiesModelOptionalExpand Deletes the image for a stamp — response body — date Stamp Properties
Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area.

This property contains the following information about the central rectangle:

- `DateAreaX`: The X axis position of the top-left corner.
- `DateAreaY`: The Y axis position of the top-left corner.
- `DateAreaWidth`: The width of the rectangle.
- `DateAreaHeight`: The height of the rectangle.
disallowUserResizeStampstringOptionalWhen **true,** users may not resize the stamp.
externalIDstringOptionalOptionally specify an external identifier for the user's signature.
imageTypestringOptionalSpecificies the type of image. Valid values:

- `stamp_image`
- `signature_image`
- `initials_image`
isDefaultstringOptionalBoolean that specifies whether the signature is the default signature for the user.
nrdsIdstringOptionalThe National Association of Realtors (NAR) membership ID for a user who is a realtor.
nrdsLastNamestringOptionalThe realtor's last name.
phoneticNamestringOptionalThe phonetic spelling of the `signatureName`.
signatureFontstringOptionalThe 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"`
signatureIdstringOptionalSpecifies 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.
signatureInitialsstringOptionalSpecifies the user's signature in initials format.
signatureNamestringOptionalSpecifies the user's signature name.
signatureTypestringOptionalSpecifies the type of signature.
stampFormatstringOptionalThe 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.
stampSizeMMstringOptionalThe physical height of the stamp image (in millimeters) that the stamp vendor recommends for displaying the image in PDF documents.

Referenced models: Deletes the image for a stamp — response body — date Stamp Properties

Deletes the image for a stamp — response body — date Stamp Properties
FieldTypePresenceDescription and constraints
$objectRootSpecifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area.

This property contains the following information about the central rectangle:

- `DateAreaX`: The X axis position of the top-left corner.
- `DateAreaY`: The Y axis position of the top-left corner.
- `DateAreaWidth`: The width of the rectangle.
- `DateAreaHeight`: The height of the rectangle.
dateAreaHeightstringOptionalThe height of the rectangle.
dateAreaWidthstringOptionalThe width of the rectangle.
dateAreaXstringOptionalThe X axis position of the top-left corner.
dateAreaYstringOptionalThe Y axis position of the top-left corner.
Locks a template — response body — error Details
FieldTypePresenceDescription and constraints
$objectRootThis object describes errors that occur. It is only valid for responses and ignored in requests.
errorCodestringOptionalThe code associated with the error condition.
messagestringOptionalA brief message describing the error condition.

SDK function policy ID: docusign.esignature_usersignatures_putusersignaturebyid. Catalog operation: esignature:UserSignatures_PutUserSignatureById. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.