# Create Embedded Signature Request with Template POST https://api.hellosign.com/v3/signature_request/create_embedded_with_template Content-Type: application/json Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. Reference: https://developer.hellosign.com/api/signature-request/create-embedded-with-template ## SDK Code Examples ```php PHP setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); $signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) ->setDraw(true) ->setPhone(false) ->setType(true) ->setUpload(true); $signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner()) ->setRole("Client") ->setName("George") ->setEmailAddress("george@example.com"); $signers = [ $signers_1, ]; $signature_request_create_embedded_with_template_request = (new Dropbox\Sign\Model\SignatureRequestCreateEmbeddedWithTemplateRequest()) ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") ->setTemplateIds([ "c26b8a16784a872da37ea946b9ddec7c1e11dff6", ]) ->setMessage("Glad we could come to an agreement.") ->setSubject("Purchase Order") ->setTestMode(true) ->setSigningOptions($signing_options) ->setSigners($signers); try { $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestCreateEmbeddedWithTemplate( signature_request_create_embedded_with_template_request: $signature_request_create_embedded_with_template_request, ); print_r($response); } catch (Dropbox\Sign\ApiException $e) { echo "Exception when calling SignatureRequestApi#signatureRequestCreateEmbeddedWithTemplate: {$e->getMessage()}"; } ``` ```csharp C# using System; using System.Collections.Generic; using System.IO; using System.Text.Json; using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; namespace Dropbox.SignSandbox; public class SignatureRequestCreateEmbeddedWithTemplateExample { public static void Run() { var config = new Configuration(); config.Username = "YOUR_API_KEY"; // config.AccessToken = "YOUR_ACCESS_TOKEN"; var signingOptions = new SubSigningOptions( defaultType: SubSigningOptions.DefaultTypeEnum.Draw, draw: true, phone: false, type: true, upload: true ); var signers1 = new SubSignatureRequestTemplateSigner( role: "Client", name: "George", emailAddress: "george@example.com" ); var signers = new List { signers1, }; var signatureRequestCreateEmbeddedWithTemplateRequest = new SignatureRequestCreateEmbeddedWithTemplateRequest( clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", templateIds: [ "c26b8a16784a872da37ea946b9ddec7c1e11dff6", ], message: "Glad we could come to an agreement.", subject: "Purchase Order", testMode: true, signingOptions: signingOptions, signers: signers ); try { var response = new SignatureRequestApi(config).SignatureRequestCreateEmbeddedWithTemplate( signatureRequestCreateEmbeddedWithTemplateRequest: signatureRequestCreateEmbeddedWithTemplateRequest ); Console.WriteLine(response); } catch (ApiException e) { Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestCreateEmbeddedWithTemplate: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } } } ``` ```typescript TypeScript import * as fs from 'fs'; import api from "@dropbox/sign" import models from "@dropbox/sign" const apiCaller = new api.SignatureRequestApi(); apiCaller.username = "YOUR_API_KEY"; // apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; const signingOptions: models.SubSigningOptions = { defaultType: models.SubSigningOptions.DefaultTypeEnum.Draw, draw: true, phone: false, type: true, upload: true, }; const signers1: models.SubSignatureRequestTemplateSigner = { role: "Client", name: "George", emailAddress: "george@example.com", }; const signers = [ signers1, ]; const signatureRequestCreateEmbeddedWithTemplateRequest: models.SignatureRequestCreateEmbeddedWithTemplateRequest = { clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", templateIds: [ "c26b8a16784a872da37ea946b9ddec7c1e11dff6", ], message: "Glad we could come to an agreement.", subject: "Purchase Order", testMode: true, signingOptions: signingOptions, signers: signers, }; apiCaller.signatureRequestCreateEmbeddedWithTemplate( signatureRequestCreateEmbeddedWithTemplateRequest, ).then(response => { console.log(response.body); }).catch(error => { console.log("Exception when calling SignatureRequestApi#signatureRequestCreateEmbeddedWithTemplate:"); console.log(error.body); }); ``` ```java Java package com.dropbox.sign_sandbox; import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; import java.io.File; import java.math.BigDecimal; import java.time.LocalDate; import java.time.OffsetDateTime; import java.util.ArrayList; import java.util.List; import java.util.Map; public class SignatureRequestCreateEmbeddedWithTemplateExample { public static void main(String[] args) { var config = Configuration.getDefaultApiClient(); ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("YOUR_ACCESS_TOKEN"); var signingOptions = new SubSigningOptions(); signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); signingOptions.draw(true); signingOptions.phone(false); signingOptions.type(true); signingOptions.upload(true); var signers1 = new SubSignatureRequestTemplateSigner(); signers1.role("Client"); signers1.name("George"); signers1.emailAddress("george@example.com"); var signers = new ArrayList(List.of ( signers1 )); var signatureRequestCreateEmbeddedWithTemplateRequest = new SignatureRequestCreateEmbeddedWithTemplateRequest(); signatureRequestCreateEmbeddedWithTemplateRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); signatureRequestCreateEmbeddedWithTemplateRequest.templateIds(List.of ( "c26b8a16784a872da37ea946b9ddec7c1e11dff6" )); signatureRequestCreateEmbeddedWithTemplateRequest.message("Glad we could come to an agreement."); signatureRequestCreateEmbeddedWithTemplateRequest.subject("Purchase Order"); signatureRequestCreateEmbeddedWithTemplateRequest.testMode(true); signatureRequestCreateEmbeddedWithTemplateRequest.signingOptions(signingOptions); signatureRequestCreateEmbeddedWithTemplateRequest.signers(signers); try { var response = new SignatureRequestApi(config).signatureRequestCreateEmbeddedWithTemplate( signatureRequestCreateEmbeddedWithTemplateRequest ); System.out.println(response); } catch (ApiException e) { System.err.println("Exception when calling SignatureRequestApi#signatureRequestCreateEmbeddedWithTemplate"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ```ruby Ruby require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| config.username = "YOUR_API_KEY" # config.access_token = "YOUR_ACCESS_TOKEN" end signing_options = Dropbox::Sign::SubSigningOptions.new signing_options.default_type = "draw" signing_options.draw = true signing_options.phone = false signing_options.type = true signing_options.upload = true signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new signers_1.role = "Client" signers_1.name = "George" signers_1.email_address = "george@example.com" signers = [ signers_1, ] signature_request_create_embedded_with_template_request = Dropbox::Sign::SignatureRequestCreateEmbeddedWithTemplateRequest.new signature_request_create_embedded_with_template_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a" signature_request_create_embedded_with_template_request.template_ids = [ "c26b8a16784a872da37ea946b9ddec7c1e11dff6", ] signature_request_create_embedded_with_template_request.message = "Glad we could come to an agreement." signature_request_create_embedded_with_template_request.subject = "Purchase Order" signature_request_create_embedded_with_template_request.test_mode = true signature_request_create_embedded_with_template_request.signing_options = signing_options signature_request_create_embedded_with_template_request.signers = signers begin response = Dropbox::Sign::SignatureRequestApi.new.signature_request_create_embedded_with_template( signature_request_create_embedded_with_template_request, ) p response rescue Dropbox::Sign::ApiError => e puts "Exception when calling SignatureRequestApi#signature_request_create_embedded_with_template: #{e}" end ``` ```python Python import json from datetime import date, datetime from pprint import pprint from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( username="YOUR_API_KEY", # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: signing_options = models.SubSigningOptions( default_type="draw", draw=True, phone=False, type=True, upload=True, ) signers_1 = models.SubSignatureRequestTemplateSigner( role="Client", name="George", email_address="george@example.com", ) signers = [ signers_1, ] signature_request_create_embedded_with_template_request = models.SignatureRequestCreateEmbeddedWithTemplateRequest( client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", template_ids=[ "c26b8a16784a872da37ea946b9ddec7c1e11dff6", ], message="Glad we could come to an agreement.", subject="Purchase Order", test_mode=True, signing_options=signing_options, signers=signers, ) try: response = api.SignatureRequestApi(api_client).signature_request_create_embedded_with_template( signature_request_create_embedded_with_template_request=signature_request_create_embedded_with_template_request, ) pprint(response) except ApiException as e: print("Exception when calling SignatureRequestApi#signature_request_create_embedded_with_template: %s\n" % e) ``` ```go Create Embedded Signature Request With Template package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.hellosign.com/v3/signature_request/create_embedded_with_template" req, _ := http.NewRequest("POST", url, nil) req.Header.Add("Authorization", "Basic :") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```swift Create Embedded Signature Request With Template import Foundation let headers = [ "Authorization": "Basic :", "Content-Type": "application/json" ] let request = NSMutableURLRequest(url: NSURL(string: "https://api.hellosign.com/v3/signature_request/create_embedded_with_template")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ``` ```php PHP setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); $signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) ->setDraw(true) ->setPhone(false) ->setType(true) ->setUpload(true); $signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner()) ->setRole("Client") ->setName("George") ->setEmailAddress("george@example.com"); $signers = [ $signers_1, ]; $signature_request_create_embedded_with_template_request = (new Dropbox\Sign\Model\SignatureRequestCreateEmbeddedWithTemplateRequest()) ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") ->setTemplateIds([ "c26b8a16784a872da37ea946b9ddec7c1e11dff6", ]) ->setMessage("Glad we could come to an agreement.") ->setSubject("Purchase Order") ->setTestMode(true) ->setSigningOptions($signing_options) ->setSigners($signers); try { $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestCreateEmbeddedWithTemplate( signature_request_create_embedded_with_template_request: $signature_request_create_embedded_with_template_request, ); print_r($response); } catch (Dropbox\Sign\ApiException $e) { echo "Exception when calling SignatureRequestApi#signatureRequestCreateEmbeddedWithTemplate: {$e->getMessage()}"; } ``` ```csharp C# using System; using System.Collections.Generic; using System.IO; using System.Text.Json; using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; namespace Dropbox.SignSandbox; public class SignatureRequestCreateEmbeddedWithTemplateExample { public static void Run() { var config = new Configuration(); config.Username = "YOUR_API_KEY"; // config.AccessToken = "YOUR_ACCESS_TOKEN"; var signingOptions = new SubSigningOptions( defaultType: SubSigningOptions.DefaultTypeEnum.Draw, draw: true, phone: false, type: true, upload: true ); var signers1 = new SubSignatureRequestTemplateSigner( role: "Client", name: "George", emailAddress: "george@example.com" ); var signers = new List { signers1, }; var signatureRequestCreateEmbeddedWithTemplateRequest = new SignatureRequestCreateEmbeddedWithTemplateRequest( clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", templateIds: [ "c26b8a16784a872da37ea946b9ddec7c1e11dff6", ], message: "Glad we could come to an agreement.", subject: "Purchase Order", testMode: true, signingOptions: signingOptions, signers: signers ); try { var response = new SignatureRequestApi(config).SignatureRequestCreateEmbeddedWithTemplate( signatureRequestCreateEmbeddedWithTemplateRequest: signatureRequestCreateEmbeddedWithTemplateRequest ); Console.WriteLine(response); } catch (ApiException e) { Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestCreateEmbeddedWithTemplate: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } } } ``` ```typescript TypeScript import * as fs from 'fs'; import api from "@dropbox/sign" import models from "@dropbox/sign" const apiCaller = new api.SignatureRequestApi(); apiCaller.username = "YOUR_API_KEY"; // apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; const signingOptions: models.SubSigningOptions = { defaultType: models.SubSigningOptions.DefaultTypeEnum.Draw, draw: true, phone: false, type: true, upload: true, }; const signers1: models.SubSignatureRequestTemplateSigner = { role: "Client", name: "George", emailAddress: "george@example.com", }; const signers = [ signers1, ]; const signatureRequestCreateEmbeddedWithTemplateRequest: models.SignatureRequestCreateEmbeddedWithTemplateRequest = { clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", templateIds: [ "c26b8a16784a872da37ea946b9ddec7c1e11dff6", ], message: "Glad we could come to an agreement.", subject: "Purchase Order", testMode: true, signingOptions: signingOptions, signers: signers, }; apiCaller.signatureRequestCreateEmbeddedWithTemplate( signatureRequestCreateEmbeddedWithTemplateRequest, ).then(response => { console.log(response.body); }).catch(error => { console.log("Exception when calling SignatureRequestApi#signatureRequestCreateEmbeddedWithTemplate:"); console.log(error.body); }); ``` ```java Java package com.dropbox.sign_sandbox; import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; import java.io.File; import java.math.BigDecimal; import java.time.LocalDate; import java.time.OffsetDateTime; import java.util.ArrayList; import java.util.List; import java.util.Map; public class SignatureRequestCreateEmbeddedWithTemplateExample { public static void main(String[] args) { var config = Configuration.getDefaultApiClient(); ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("YOUR_ACCESS_TOKEN"); var signingOptions = new SubSigningOptions(); signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); signingOptions.draw(true); signingOptions.phone(false); signingOptions.type(true); signingOptions.upload(true); var signers1 = new SubSignatureRequestTemplateSigner(); signers1.role("Client"); signers1.name("George"); signers1.emailAddress("george@example.com"); var signers = new ArrayList(List.of ( signers1 )); var signatureRequestCreateEmbeddedWithTemplateRequest = new SignatureRequestCreateEmbeddedWithTemplateRequest(); signatureRequestCreateEmbeddedWithTemplateRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); signatureRequestCreateEmbeddedWithTemplateRequest.templateIds(List.of ( "c26b8a16784a872da37ea946b9ddec7c1e11dff6" )); signatureRequestCreateEmbeddedWithTemplateRequest.message("Glad we could come to an agreement."); signatureRequestCreateEmbeddedWithTemplateRequest.subject("Purchase Order"); signatureRequestCreateEmbeddedWithTemplateRequest.testMode(true); signatureRequestCreateEmbeddedWithTemplateRequest.signingOptions(signingOptions); signatureRequestCreateEmbeddedWithTemplateRequest.signers(signers); try { var response = new SignatureRequestApi(config).signatureRequestCreateEmbeddedWithTemplate( signatureRequestCreateEmbeddedWithTemplateRequest ); System.out.println(response); } catch (ApiException e) { System.err.println("Exception when calling SignatureRequestApi#signatureRequestCreateEmbeddedWithTemplate"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ```ruby Ruby require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| config.username = "YOUR_API_KEY" # config.access_token = "YOUR_ACCESS_TOKEN" end signing_options = Dropbox::Sign::SubSigningOptions.new signing_options.default_type = "draw" signing_options.draw = true signing_options.phone = false signing_options.type = true signing_options.upload = true signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new signers_1.role = "Client" signers_1.name = "George" signers_1.email_address = "george@example.com" signers = [ signers_1, ] signature_request_create_embedded_with_template_request = Dropbox::Sign::SignatureRequestCreateEmbeddedWithTemplateRequest.new signature_request_create_embedded_with_template_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a" signature_request_create_embedded_with_template_request.template_ids = [ "c26b8a16784a872da37ea946b9ddec7c1e11dff6", ] signature_request_create_embedded_with_template_request.message = "Glad we could come to an agreement." signature_request_create_embedded_with_template_request.subject = "Purchase Order" signature_request_create_embedded_with_template_request.test_mode = true signature_request_create_embedded_with_template_request.signing_options = signing_options signature_request_create_embedded_with_template_request.signers = signers begin response = Dropbox::Sign::SignatureRequestApi.new.signature_request_create_embedded_with_template( signature_request_create_embedded_with_template_request, ) p response rescue Dropbox::Sign::ApiError => e puts "Exception when calling SignatureRequestApi#signature_request_create_embedded_with_template: #{e}" end ``` ```python Python import json from datetime import date, datetime from pprint import pprint from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( username="YOUR_API_KEY", # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: signing_options = models.SubSigningOptions( default_type="draw", draw=True, phone=False, type=True, upload=True, ) signers_1 = models.SubSignatureRequestTemplateSigner( role="Client", name="George", email_address="george@example.com", ) signers = [ signers_1, ] signature_request_create_embedded_with_template_request = models.SignatureRequestCreateEmbeddedWithTemplateRequest( client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", template_ids=[ "c26b8a16784a872da37ea946b9ddec7c1e11dff6", ], message="Glad we could come to an agreement.", subject="Purchase Order", test_mode=True, signing_options=signing_options, signers=signers, ) try: response = api.SignatureRequestApi(api_client).signature_request_create_embedded_with_template( signature_request_create_embedded_with_template_request=signature_request_create_embedded_with_template_request, ) pprint(response) except ApiException as e: print("Exception when calling SignatureRequestApi#signature_request_create_embedded_with_template: %s\n" % e) ``` ```go Default Example package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.hellosign.com/v3/signature_request/create_embedded_with_template" payload := strings.NewReader("{\n \"template_ids\": [\n \"c26b8a16784a872da37ea946b9ddec7c1e11dff6\"\n ],\n \"client_id\": \"b6b8e7deaf8f0b95c029dca049356d4a2cf9710a\",\n \"signers\": [\n {\n \"role\": \"Client\",\n \"name\": \"George\",\n \"email_address\": \"george@example.com\"\n }\n ],\n \"message\": \"Glad we could come to an agreement.\",\n \"signing_options\": {\n \"default_type\": \"draw\",\n \"draw\": true,\n \"phone\": false,\n \"type\": true,\n \"upload\": true\n },\n \"subject\": \"Purchase Order\",\n \"test_mode\": true\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Basic :") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```swift Default Example import Foundation let headers = [ "Authorization": "Basic :", "Content-Type": "application/json" ] let parameters = [ "template_ids": ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], "client_id": "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", "signers": [ [ "role": "Client", "name": "George", "email_address": "george@example.com" ] ], "message": "Glad we could come to an agreement.", "signing_options": [ "default_type": "draw", "draw": true, "phone": false, "type": true, "upload": true ], "subject": "Purchase Order", "test_mode": true ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.hellosign.com/v3/signature_request/create_embedded_with_template")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```