Send Signature Request
POST https://api.hellosign.com/v3/signature_request/send
Creates and sends a new SignatureRequest with the submitted documents. 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.
Additional information can be found here.
Request Body
[{"name"=>"test_mode", "value"=>"{{test_mode}}", "datatype"=>"string"}, {"name"=>"file[0]", "value"=>nil, "datatype"=>"null"}, {"name"=>"file_url[0]", "value"=>"http://www.example.com/contract.pdf", "datatype"=>"string"}, {"name"=>"title", "value"=>"Example Signature Request Title", "datatype"=>"string"}, {"name"=>"subject", "value"=>"Example Email Subject", "datatype"=>"string"}, {"name"=>"message", "value"=>"Example Email Message", "datatype"=>"string"}, {"name"=>"signing_redirect_url", "value"=>"http://www.example.com", "datatype"=>"string"}, {"name"=>"signers[0][name]", "value"=>"Alice", "datatype"=>"string"}, {"name"=>"signers[0][email_address]", "value"=>"alice@example.com", "datatype"=>"string"}, {"name"=>"signers[0][order]", "value"=>"0", "datatype"=>"number"}, {"name"=>"signers[0][pin]", "value"=>"1234", "datatype"=>"number"}, {"name"=>"signers[0][group]", "value"=>"Example Signer Group", "datatype"=>"string"}, {"name"=>"signers[0][1][name]", "value"=>"Alice", "datatype"=>"string"}, {"name"=>"signers[0][1][email_address]", "value"=>"alice@example.com", "datatype"=>"string"}, {"name"=>"signers[0][2][name]", "value"=>"Bob", "datatype"=>"string"}, {"name"=>"signers[0][2][email_address]", "value"=>"bob@example.com", "datatype"=>"string"}, {"name"=>"attachments[0][name]", "value"=>"Example Attachment", "datatype"=>"string"}, {"name"=>"attachments[0][instructions]", "value"=>"Add your attachment", "datatype"=>"string"}, {"name"=>"attachments[0][signer_index]", "value"=>"0", "datatype"=>"number"}, {"name"=>"attachments[0][required]", "value"=>"1", "datatype"=>"number"}, {"name"=>"custom_fields", "value"=>"[{\"name\": \"Address\", \"value\": \"123 Main St.\"}, {\"name\": \"zip\", \"value\": \"92606\"}]", "datatype"=>"string"}, {"name"=>"cc_email_addresses[0]", "value"=>"charlie@example.com", "datatype"=>"string"}, {"name"=>"use_text_tags", "value"=>"1", "datatype"=>"number"}, {"name"=>"hide_text_tags", "value"=>"0", "datatype"=>"number"}, {"name"=>"metadata[example_key]", "value"=>"Example Metadata Value", "datatype"=>"string"}, {"name"=>"client_id", "value"=>"{{client_id}}", "datatype"=>"string"}, {"name"=>"allow_decline", "value"=>"0", "datatype"=>"number"}, {"name"=>"allow_reassign", "value"=>"0", "datatype"=>"number"}, {"name"=>"form_fields_per_document", "value"=>"[[{\"api_id\": \"field1\", \"name\": \"address\", \"type\": \"text\", \"x\": 160, \"y\": 80, \"page\": 1, \"width\": 206, \"height\": 32, \"required\": true, \"signer\": 0}]]", "datatype"=>"string"}]