Docusign eSignature API
Docusign Developer CenterGet a developer account
HomeAPI ReferenceSDKsContext Plugin
Account Signatures

Sets a signature image, initials, or stamp

PUT
/v2.1/accounts/{accountId}/signatures/{signatureId}/{imageType}

Sets a signature image, initials, or stamp.

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.

Query Parameters

transparent_png?string

Header Parameters

Content-Type*"image/gif"

Value in

  • "image/gif"

Response Body

application/json

application/json

curl -X PUT "https://example.com/v2.1/accounts/string/signatures/string/string" \  -H "Content-Type: image/gif"
{  "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",  "signatureGroups": [    {      "groupId": "string",      "groupName": "string",      "rights": "string"    }  ],  "signatureId": "string",  "signatureImageUri": "string",  "signatureInitials": "string",  "signatureName": "string",  "signatureRights": "string",  "signatureType": "string",  "signatureUsers": [    {      "isDefault": "string",      "rights": "string",      "userId": "string",      "userName": "string"    }  ],  "stampFormat": "string",  "stampImageUri": "string",  "stampSizeMM": "string",  "stampType": "string",  "status": "string"}

Deletes the image for a stamp DELETE

Deletes the image for a stamp specified by `signatureId`.

Submits a batch of historical envelopes for republish to a webhook POST

This endpoint submits a batch of existing envelopes to a webhook of your choice. Set the webhook address with the `urlToPublishTo` request body parameter. This endpoint does not call an existing Connect configuration or create a new Connect listener to monitor new activity. It simply uses an ad hoc configuration to submit existing envelopes. You must include all the configuration data in the request body. The envelope data will always be transmitted in JSON format. XML, Salesforce, and eOriginal configuration types are not supported. Your request should match the following format: ``` { "envelopes": ["4280f274-xxxx-xxxx-xxxx-b218b7eeda08", "8373a938-xxxx-xxxx-xxxx-e992a2abae01"], "config": { "configurationType":"custom", "name": "Test", "urlToPublishTo":"YOUR-WEBHOOK-URL", "allowEnvelopePublish": "true", "enableLog": "true", "requiresAcknowledgement": "true", "IncludeHMAC": "true", "SignMessageWithX509Cert": "true", "deliveryMode": "SIM", "eventData": { "version": "restv2.1", "format": "json", "includedata": ["tabs","payment_tabs","custom_fields","powerform","recipients","folders","extensions","attachments", "prefill_tabs", "documents"] } } } ``` If the request succeeds, it returns a 201 (Created) HTTP response code and the response body property `processingStatus` will be set to `processing`. You can then view the status of each historical republish request in the [Bulk Actions Log](https://support.docusign.com/s/document-item?bundleId=pik1583277475390&topicId=nvf1648497452396.html).