docusign.user-signatures.delete-user-signature-image

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

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

Overview

Property	Value
Workflow type	Atomic
Library	App-docusign
Version	1.0

Input Schema

Field	Type	Required	Default	Description
`base_url`	string	Yes	—	Docusign API root, e.g. https://<host>/api
`api_token`	string	No	—	Bearer token; omit to use the workflow's token env var
`accountid`	string	Yes	—	The external account number (int) or account ID GUID.
`imagetype`	string	Yes	—	Specificies the type of image. Valid values: - `stamp_image` - `signature_image` - `initials_image`
`signatureid`	string	Yes	—	The ID of the account stamp.
`userid`	string	Yes	—	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.

Output Schema

Field	Type	Required	Default	Description
`base_url`	string	Yes	—	Docusign API root, e.g. https://<host>/api
`api_token`	string	No	—	Bearer token; omit to use the workflow's token env var
`accountid`	string	Yes	—	The external account number (int) or account ID GUID.
`imagetype`	string	Yes	—	Specificies the type of image. Valid values: - `stamp_image` - `signature_image` - `initials_image`
`signatureid`	string	Yes	—	The ID of the account stamp.
`userid`	string	Yes	—	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.
`status_code`	integer	No	—	HTTP status code of the completed call
`response`	json	No	—	Parsed JSON response body
`failure_reason`	string	No	—	—
`failure_type`	string	No	—	—
`failed_at`	string	No	—	—
`failed_step`	string	No	—	—
`failed_layer`	string	No	—	—
`failed_at_state`	string	No	—	—
`error`	string	No	—	—
`error_type`	string	No	—	—

States

State	Initial	Terminal	Success	Auto-advance	Description
`pending`	Yes	No	—	`execute`	Waiting to call DELETE /v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}/
`completed`	No	Yes	Yes	—	HTTP call succeeded
`failed`	No	Yes	No	—	HTTP call failed

State Diagram

Transitions

From	Action	To	Description
`pending`	`execute`	`completed`	Perform DELETE /v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}/
`*` (any state)	`fail`	`failed`	Record the failure reason

API Usage

bash

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "docusign.user-signatures.delete-user-signature-image",
  "initial_data": {
    "base_url": "value",
    "accountid": "value",
    "imagetype": "value",
    "signatureid": "value"
  }
}

docusign.user-signatures.delete-user-signature-image ​

Overview ​

Input Schema ​

Output Schema ​

States ​

State Diagram ​

Transitions ​

API Usage ​