Dropbox Sign Developer Documentation

curl -X POST 'https://api.hellosign.com/v3/signature_request/update/{signature_request_id}' \
  -u 'YOUR_API_KEY:' \
  -F 'email_address=john@example.com' \
  -F 'signature_id=2f9781e1a8e2045224d808c153c2e1d3df6f8f2f'

{
  "signature_request": {
    "signature_request_id": "fa5c8a0b0f492d768749333ad6fcc214c111e967",
    "requester_email_address": "me@dropboxsign.com",
    "title": "Purchase Agreement",
    "subject": "Purchase Agreement",
    "message": "Please sign and return.",
    "created_at": 1570471067,
    "is_complete": true,
    "has_error": false,
    "signing_url": null,
    "details_url": "https://app.hellosign.com/home/manage?guid=fa5c8a0b0f492d768749333ad6fcc214c111e967",
    "cc_email_addresses": [],
    "signing_redirect_url": null,
    "custom_fields": [],
    "signatures": [
      {
        "signature_id": "78caf2a1d01cd39cea2bc1cbb340dac3",
        "signer_email_address": "danaerys@mereen.gov.ws",
        "signer_name": "Danaerys Stormborn",
        "signer_role": null,
        "order": null,
        "status_code": "awaiting_signature",
        "signed_at": null,
        "last_viewed_at": null,
        "last_reminded_at": null,
        "has_pin": false,
        "has_sms_auth": false
      }
    ]
  }
}

Updates the email address and/or the name for a given signer on a signature request. You can listen for the signature_request_email_bounce event on your app or account to detect bounced emails, and respond with this method.

Updating the email address of a signer will generate a new signature_id value.

NOTE: This action cannot be performed on a signature request with an appended signature page.

Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. Updating the email address of a signer will generate a new `signature_id` value. **NOTE:** This action cannot be performed on a signature request with an appended signature page.

Authentication

AuthorizationBasic

Your API key can be used to make calls to the Dropbox Sign API. See Authentication for more information. ✅ Supported by Try it console (calls sent in test_mode only).

AuthorizationBearer

You can use an Access Token issued through an OAuth flow to send calls to the Dropbox Sign API from your app. The access scopes required by this endpoint are listed in the gray box above. See Authentication for more information. ❌ Not supported by Try it console.

You can use an Access Token issued through an OAuth flow to send calls to the Dropbox Sign API from your app. The access scopes required by this endpoint are listed in the gray box above. See [Authentication](/api/reference/authentication) for more information. ❌ **Not supported** by Try it console.

Path parameters

signature_request_idstringRequired

The id of the SignatureRequest to update.

Request

This endpoint expects an object.

signature_idstringRequired

The signature ID for the recipient.

email_addressstringOptionalformat: "email"

The new email address for the recipient.

This will generate a new signature_id value.

NOTE: Optional if name is provided.

namestringOptional

The new name for the recipient.

NOTE: Optional if email_address is provided.

expires_atinteger or nullOptional

The new time when the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See Signature Request Expiration Date for details.

Response headers

X-RateLimit-Limitinteger

The maximum number of requests per hour that you can make.

X-RateLimit-Remaininginteger

The number of requests remaining in the current rate limit window.

X-Ratelimit-Resetinteger

The Unix time at which the rate limit will reset to its maximum.

Response

successful operation

signature_requestobject

Contains information about a signature request.

warningslist of objects

A list of warnings.

Errors

4XX

Client Request Error