Create Embedded Edit Url

The Create Embedded Edit Url API allows you to generate an embedded link for editing documents that are in progress, scheduled as drafts, or saved in draft state. With this link, users can make changes and then either send the document immediately or schedule it for later.

For in-progress documents, users can edit and send the updated version right away.
For scheduled drafts, users can cancel the existing schedule, edit the document, and either send instantly or reschedule.
For drafts, users can edit and choose to send immediately or set a new schedule.

Changes made through the embedded URL are only applied when the document is sent or scheduled; no updates are saved in-between.

Get embedded document edit URL

post/v1-beta/document/createEmbeddedEditUrl

Generating an embedded document edit URL creates a unique link that lets you edit a specific document directly. If you generate more than one link for the same document, only the latest link will remain active for editing, while the older ones will lose access. This works just like editing through the web app, but the embedded link also includes extra settings designed specifically for the embedded editing experience.

This API supports both multipart/form-data and application/json content types.

Code snippet

curl -X POST 'https://api.boldsign.com/v1-beta/document/createEmbeddedEditUrl?documentId=625cff3d...' \
  -H 'X-API-KEY: {your API key}' \
  -H 'Content-Type: application/json' \
  -d '{
      "RedirectUrl": "https://yourapp.example/redirect",
      "ShowToolbar": true,
      "SendViewOption": "FillingPage",
      "ShowSendButton": true,
      "ShowPreviewButton": true,
      "ShowNavigationButtons": true,
      "OnBehalfOf": "sender@yourdomain.com",
      "LinkValidTill": "2022-10-21T06:37:57.424Z",
      "Locale": "EN"
  }'

var apiClient = new ApiClient("https://api.boldsign.com", "Your_API_Key");
var documentClient = new DocumentClient(apiClient);

var request = new EmbeddedDocumentEditRequest
{
    DocumentId = "625cff3d...",
    RedirectUrl = new Uri("https://example.com/after-edit"),
    ShowToolbar = true,
    SendViewOption = PageViewOption.PreparePage,
    Locale = Locales.EN,
    ShowSendButton = true,
    ShowPreviewButton = true,
    ShowNavigationButtons = true,
    LinkValidTill = DateTime.Parse("2025-01-31T23:59:59Z"),
    OnBehalfOf = "sender@yourdomain.com",
};

var response = await documentClient.CreateEmbeddedEditUrlasync(request);
var editUrl = response.EditUrl;

import boldsign
from datetime import datetime

configuration = boldsign.Configuration(api_key="YOUR_API_KEY")
with boldsign.ApiClient(configuration) as api_client:
    document_api = boldsign.DocumentApi(api_client)

    request = boldsign.EmbeddedDocumentEditRequest(
        documentId = "625cff3d...",
        redirectUrl="https://example.com/after-edit",
        showToolbar=True,
        sendViewOption="PreparePage",
        locale="EN",
        showSendButton=True,
        showPreviewButton=True,
        showNavigationButtons=True,
        linkValidTill="2025-01-31T23:59:59Z",
        onBehalfOf="sender@yourdomain.com"
    )

    result = document_api.create_embedded_edit_url_async(embedded_document_edit_request=request)
    edit_url = result.editUrl

<?php require_once "vendor/autoload.php";

use BoldSign\Configuration;
use BoldSign\Api\DocumentApi;
use BoldSign\Model\EmbeddedDocumentEditRequest;

$config = new Configuration();
$config->setApiKey('YOUR_API_KEY');
$document_api = new DocumentApi($config);

$request = new EmbeddedDocumentEditRequest();
$request->setDocumentId('625cff3d...');
$request->setRedirectUrl('https://example.com/after-edit');
$request->setShowToolbar(true);
$request->setSendViewOption('PreparePage');
$request->setLocale('EN');
$request->setShowSendButton(true);
$request->setShowPreviewButton(true);
$request->setShowNavigationButtons(true);
$request->setLinkValidTill('2025-01-31T23:59:59Z');
$request->setOnBehalfOf('sender@yourdomain.com');

$result = $document_api->createEmbeddedEditUrlasync($request);
$editUrl = $result->getEditUrl();

ApiClient client = Configuration.getDefaultApiClient();
client.setApiKey("YOUR_API_KEY");
DocumentApi documentApi = new DocumentApi(client);

EmbeddedDocumentEditRequest request = new EmbeddedDocumentEditRequest();
request.setDocumentId("625cff3d...");
request.setRedirectUrl("https://example.com/after-edit");
request.setShowToolbar(true);
request.setSendViewOption(EmbeddedDocumentEditRequest.SendViewOptionEnum.PREPARE_PAGE);
request.setLocale(EmbeddedDocumentEditRequest.LocaleEnum.EN);
request.setShowSendButton(true);
request.setShowPreviewButton(true);
request.setShowNavigationButtons(true);
request.setLinkValidTill(OffsetDateTime.parse("2025-01-31T23:59:59Z"));
request.setOnBehalfOf("sender@yourdomain.com");

EmbeddedDocumentEdited result = documentApi.createEmbeddedEditUrlasync(request);
URI editUrl = result.getEditUrl();

import { DocumentApi, EmbeddedDocumentEditRequest } from "boldsign";

const documentApi = new DocumentApi();
documentApi.setApiKey("YOUR_API_KEY");

const request = new EmbeddedDocumentEditRequest();
request.documentId = "625cff3d...";
request.redirectUrl = "https://example.com/after-edit";
request.showToolbar = true;
request.sendViewOption = EmbeddedDocumentEditRequest.SendViewOptionEnum.PreparePage;
request.locale = "EN";
request.showSendButton = true;
request.showPreviewButton = true;
request.showNavigationButtons = true;
request.linkValidTill = "2025-01-31T23:59:59Z";
request.onBehalfOf = "sender@yourdomain.com";

const result = await documentApi.createEmbeddedEditUrlasync(request);
const editUrl = result.editUrl;

Query parameters

documentIdstringRequired

The unique document id of the document.

Request body

RedirectUrlstring	The redirect URI will be redirected after the document edit process is complete. The string should be in URI format.
ShowToolbarboolean	Controls the visibility of the toolbar at the top of the document editor. Defaults to false.
SendViewOptionstring	Configures the initial view page to be loaded from the generated URL. The FillingPage is used to customize signers, authentication etc. The PreparePage is used to configure signers form fields. Either PreparePage or FillingPage. Defaults to PreparePage.
ShowSendButtonboolean	Controls the visibility of the `Send` button at the top right corner of the page. Defaults to true.
ShowPreviewButtonboolean	Controls the visibility of the `Preview` button. Set to false if you don't want your users to preview the document before sending it out for signature. Defaults to true.
ShowNavigationButtonsboolean	Controls the visibility of the `Back` button. Set to false if you don't want your users to navigate away from the current page. Defaults to true.
LinkValidTillstring	Configures the expiration for the generated URL. A maximum of 30 days can be assigned. If no value is provided, the expiration is automatically set to 30 minutes. The String should be in date-time format.
Localestring	By default, while opening the embedded request link, all the static contents available in the page will be loaded in the English language. This property is used to load the contents with different languages. The supported languages are EN(English), FR(French), NO(Norwegian), DE(German), ES(Spanish), BG(Bulgarian), CS(Czech), DA(Danish), IT(Italian), NL(Dutch), PL(Polish), PT(Portuguese), RO(Romanian), RU(Russian), SV(Swedish)
OnBehalfOfstring	Sender email address to act on behalf of another user during the embedded edit flow.

Response

{
  "editUrl": "https://app.boldsign.com/document/embed/?documentId=b6**4e4d-19d7-4092-8*ce-e742d8**ffb2e_2q83*1cW;d69739ea-7**4-40d9-abde-ce99d**f99b6&isEmbedEditDocument=true"
}