Create Embedded Unclaimed Draft with Template
POST https://api.hellosign.com/v3/unclaimed_draft/create_embedded_with_template
Creates a new Draft with a previously saved template that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the Request signature
page with the Draft loaded. Subsequent access to the claim URL will result in a 404. For this embedded endpoint the requester_email_address parameter
is required. Note: embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on HelloSign.
Additional information can be found here.
Request Body
[{"name"=>"test_mode", "value"=>"{{test_mode}}", "datatype"=>"string"}, {"name"=>"client_id", "value"=>"{{client_id}}", "datatype"=>"string"}, {"name"=>"template_id", "value"=>":template_id", "datatype"=>"string"}, {"name"=>"requester_email_address", "value"=>"alice@example.com", "datatype"=>"string"}, {"name"=>"type", "value"=>"request_signature", "datatype"=>"string"}, {"name"=>"subject", "value"=>"Example Email Subject", "datatype"=>"string"}, {"name"=>"message", "value"=>"Example Email Message", "datatype"=>"string"}, {"name"=>"signers[ExampleRole][name]", "value"=>"Bob", "datatype"=>"string"}, {"name"=>"signers[ExampleRole][email_address]", "value"=>"bob@example.com", "datatype"=>"string"}, {"name"=>"ccs[CCRole][email_address]", "value"=>"charlie@example.com", "datatype"=>"string"}, {"name"=>"signing_redirect_url", "value"=>"http://www.example.com", "datatype"=>"string"}, {"name"=>"requesting_redirect_url", "value"=>"http://www.example.com", "datatype"=>"string"}, {"name"=>"is_for_embedded_signing", "value"=>"1", "datatype"=>"number"}, {"name"=>"metadata[example_key]", "value"=>"Example Metadata Value", "datatype"=>"string"}, {"name"=>"custom_fields", "value"=>"[{\"name\": \"Address\", \"value\": \"123 Main St.\"}, {\"name\": \"zip\", \"value\": \"92606\"}]", "datatype"=>"string"}, {"name"=>"file[0]", "value"=>nil, "datatype"=>"null"}, {"name"=>"file_url[0]", "value"=>"http://www.example.com/contract.pdf", "datatype"=>"string"}, {"name"=>"skip_me_now", "value"=>"1", "datatype"=>"number"}, {"name"=>"allow_decline", "value"=>"0", "datatype"=>"number"}, {"name"=>"allow_reassign", "value"=>"0", "datatype"=>"number"}]