Create Embedded Template Url

POST {{apiBaseUrl}}/v1/template/createEmbeddedTemplateUrl

The embedded template link is created in the same way as the regular template, but with additional properties to customize the embedded process.

Request Body

[{"name"=>"RedirectUrl", "value"=>"https://boldsign.com/esignature-api/", "datatype"=>"string"}, {"name"=>"ShowToolbar", "value"=>"true", "datatype"=>"boolean"}, {"name"=>"ViewOption", "value"=>"PreparePage", "datatype"=>"string"}, {"name"=>"ShowSaveButton", "value"=>"true", "datatype"=>"boolean"}, {"name"=>"ShowSendButton", "value"=>"true", "datatype"=>"boolean"}, {"name"=>"ShowPreviewButton", "value"=>"true", "datatype"=>"boolean"}, {"name"=>"ShowNavigationButtons", "value"=>"true", "datatype"=>"boolean"}, {"name"=>"Title", "value"=>"Service-level agreement", "datatype"=>"string"}, {"name"=>"Description", "value"=>"A service-level agreement is a commitment between a service provider and a client. Particular aspects of the service – quality, availability, responsibilities – are agreed between the service provider and the service user.", "datatype"=>"string"}, {"name"=>"DocumentMessage", "value"=>"Service level agreement metrics are a way of measuring whether your business or service provider is meeting the standards you have set for yourself.", "datatype"=>"string"}, {"name"=>"Roles[0][Name]", "value"=>"HR", "datatype"=>"string"}, {"name"=>"Roles[0][Index]", "value"=>"1", "datatype"=>"number"}, {"name"=>"Roles[0][DefaultSignerName]", "value"=>"Alex Gayle", "datatype"=>"string"}, {"name"=>"Roles[0][DefaultSignerEmail]", "value"=>"alexgayle@cubeflakes.com", "datatype"=>"string"}, {"name"=>"Roles[0][SignerOrder]", "value"=>"1", "datatype"=>"number"}, {"name"=>"Roles[0][SignerType]", "value"=>"Signer", "datatype"=>"string"}, {"name"=>"Roles[0][Locale]", "value"=>"EN", "datatype"=>"string"}, {"name"=>"Roles[0][ImposeAuthentication]", "value"=>"EmailOTP", "datatype"=>"string"}, {"name"=>"Roles[0][DeliveryMode]", "value"=>"Email", "datatype"=>"string"}, {"name"=>"CC[0][EmailAddress]", "value"=>"stacywilson@cubeflakes.com", "datatype"=>"string"}, {"name"=>"AllowNewRoles", "value"=>"true", "datatype"=>"boolean"}, {"name"=>"AllowMessageEditing", "value"=>"true", "datatype"=>"boolean"}, {"name"=>"EnableSigningOrder", "value"=>"true", "datatype"=>"boolean"}, {"name"=>"DocumentInfo[0][Title]", "value"=>"Welcome", "datatype"=>"string"}, {"name"=>"DocumentInfo[0][Locale]", "value"=>"EN", "datatype"=>"string"}, {"name"=>"DocumentInfo[0][Description]", "value"=>"German language, German Deutsch, official language of both Germany and Austria and one of the official languages of Switzerland", "datatype"=>"string"}, {"name"=>"BrandId", "value"=>"eb27a99a-9c09-477a-9903-b46df35a7f49", "datatype"=>"string"}, {"name"=>"EnableReassign", "value"=>"true", "datatype"=>"boolean"}, {"name"=>"Files", "value"=>nil, "datatype"=>"null"}, {"name"=>"DocumentDownloadOption", "value"=>"Combined", "datatype"=>"string"}]

RESPONSES

status: Created

{"templateId":"5ffd9ca1-349c-49a0-b2c5-2944a1e36dcc","createUrl":"https://app.boldsign.com/document/embed/?templateId=5ffd9ca1-349c-49a0-b2c5-2944a1e36dcce_34ffVdG6;ef10f61f-5643-47f7-8210-c10bd1161e3c"}