Dropbox Sign/signatureRequestEditEmbedded

Preview only · details below

Dropbox SignDropbox Sign eSignature API

PUT/signature_request/edit_embedded/{signature_request_id}

Edit Embedded Signature Request

Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota.

Manage accounts, signature requests, templates, teams, bulk sends, file downloads, fax, and event callbacks through the complete Dropbox Sign v3 API; the Hub provides documentation and a local SDK/CLI only.

Request

operationId
signatureRequestEditEmbedded
Server
https://api.hellosign.com/v3
Authentication
api_key, oauth2

Request parameters

signature_request_id

pathstringrequired

The id of the SignatureRequest to edit.

fa5c8a0b0f492d768749333ad6fcc214c111e967

Request body

SignatureRequestEditEmbeddedRequestrequired

Content-Type: application/json, multipart/form-data

Properties: filesfile_urlssignersgrouped_signersallow_declineallow_reassignattachmentscc_email_addressesclient_idcustom_fieldsfield_optionsform_field_groupsform_field_rulesform_fields_per_documenthide_text_tagsmessagemetadatasigning_optionssubjecttest_modetitleuse_text_tagspopulate_auto_fill_fieldsexpires_at

{
  "files": [
    {}
  ],
  "file_urls": [
    "https://example.com/resource"
  ],
  "signers": [
    {
      "name": "Example Name",
      "email_address": "developer@example.com",
      "order": 0,
      "sms_phone_number": "+12025550123",
      "sms_phone_number_type": "authentication"
    }
  ],
  "grouped_signers": [
    {
      "order": 0,
      "signers": [
        {
          "name": "Example Name",
          "email_address": "developer@example.com",
          "order": 0,
          "sms_phone_number": "+12025550123",
          "sms_phone_number_type": "authentication"
        }
      ]
    }
  ],
  "allow_decline": false,
  "allow_reassign": false,
  "attachments": [
    {
      "name": "Example Name",
      "required": false,
      "signer_index": 0
    }
  ],
  "cc_email_addresses": [
    "developer@example.com"
  ]
}

Responses

200

SignatureRequestGetResponseapplication/json

successful operation

Properties: signature_requestwarnings

4XX

ErrorResponseapplication/json

failed_operation

Properties: error

{
  "signature_request": {
    "test_mode": false,
    "signature_request_id": "example-signature-request-id",
    "requester_email_address": "developer@example.com",
    "title": "Example document",
    "original_title": "Example document",
    "subject": "Example document",
    "message": "Example message",
    "metadata": {}
  },
  "warnings": [
    {
      "warning_name": "Example Name"
    }
  ]
}