DocuSign: Adds updates a user signature
DocuSign esignature.esignatureUserSignaturesPutUserSignature: arguments, response, policy and SDK examples.
← Esignature operations · Get started
Operation docusign.esignature_usersignatures_putusersignature
Provider route: PUT /restapi/v2.1/accounts/{accountId}/users/{userId}/signatures. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”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"]["esignatureUserSignaturesPutUserSignature"]>[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.esignatureUserSignaturesPutUserSignature(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom 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(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.accountId | string | Required within parent | |
path.userId | string | Required within parent | |
body | Model | Optional | Expand Adds updates a user signature — response body |
Referenced models: Adds updates a user signature — response body
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Adds updates a user signature — response body |
Referenced models: Adds updates a user signature — response body
Schemas
Section titled “Schemas”Adds updates a user signature — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
userSignatures | array | Optional | An array of `userSignature` objects. |
userSignatures[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
adoptedDateTime | string | Optional | The date and time the user adopted their signature. |
createdDateTime | string | Optional | The UTC DateTime when the item was created. |
customField | string | Optional | |
dateStampProperties | Model | Optional | Expand 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. |
disallowUserResizeStamp | string | Optional | When **true,** users may not resize the stamp. |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
externalID | string | Optional | Optionally specify an external identifier for the user's signature. |
imageBase64 | string | Optional | A Base64-encoded representation of the signature image. |
imageType | string | Optional | Specificies the type of image. Valid values: - `stamp_image` - `signature_image` - `initials_image` |
initials150ImageId | string | Optional | The ID of the user's initials image. |
initialsImageUri | string | Optional | The URI for retrieving the image of the user's initials. |
isDefault | string | Optional | Boolean that specifies whether the signature is the default signature for the user. |
lastModifiedDateTime | string | Optional | The date and time that the item was last modified. |
nrdsId | string | Optional | The National Association of Realtors (NAR) membership ID for a user who is a realtor. |
nrdsLastName | string | Optional | The realtor's last name. |
nrdsStatus | string | Optional | The 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` |
phoneticName | string | Optional | The phonetic spelling of the `signatureName`. |
signature150ImageId | string | Optional | The ID of the user's signature image. |
signatureFont | string | Optional | 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 | Optional | 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 | Optional | An endpoint URI that you can use to retrieve the user's signature image. |
signatureInitials | string | Optional | The initials associated with the signature. |
signatureName | string | Optional | Specifies the user's signature name. |
signatureRights | string | Optional | The rights that the user has to the signature. Valid values are: - `none` - `read` - `admin` |
signatureType | string | Optional | Specifies the type of signature. |
stampFormat | string | Optional | 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. |
stampImageUri | string | Optional | The URI for retrieving the image of the user's stamp. |
stampSizeMM | string | Optional | The physical height of the stamp image (in millimeters) that the stamp vendor recommends for displaying the image in PDF documents. |
stampType | string | Optional | The type of stamp. Valid values are: - `signature`: A signature image. This is the default value. - `stamp`: A stamp image. - null |
status | string | Optional | Indicates 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
Deletes the image for a stamp — response body — date Stamp Properties
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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. |
dateAreaHeight | string | Optional | The height of the rectangle. |
dateAreaWidth | string | Optional | The width of the rectangle. |
dateAreaX | string | Optional | The X axis position of the top-left corner. |
dateAreaY | string | Optional | The Y axis position of the top-left corner. |
Locks a template — response body — error Details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object describes errors that occur. It is only valid for responses and ignored in requests. |
errorCode | string | Optional | The code associated with the error condition. |
message | string | Optional | A brief message describing the error condition. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: docusign.esignature_usersignatures_putusersignature. Catalog operation: esignature:UserSignatures_PutUserSignature. 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.