Embedded Custom Field Create URL

post/v1/customField/createEmbeddedCustomFieldUrl

This API enables users to generate an embedded custom field creation link, which can be seamlessly integrated into their applications through an iFrame or opened in a web browser to create, edit, or delete custom fields directly.

Code snippet

curl -X 'POST' \
  'https://api.boldsign.com/v1/customField/createEmbeddedCustomFieldUrl?BrandId={brandId}&LinkValidTill=2023-05-06T09%3A12%3A28Z' \
  -H 'accept: application/json' \
  -H 'X-API-KEY: {your API key}' \
  -d ''
var apiClient = new ApiClient("YOUR_API_KEY");

var customFieldClient = new CustomFieldClient(apiClient);

var embeddedCustomFieldDetails = new EmbeddedCustomFieldDetails()
{
    BrandId = "YOUR_BRAND_ID", 
};

var embeddedCustomFieldCreated = customFieldClient.CreateEmbeddedCustomFieldUrl(embeddedCustomFieldDetails);
import boldsign

configuration = boldsign.Configuration(api_key="YOUR_API_KEY")

with boldsign.ApiClient(configuration) as api_client:
    
    custom_field_api = boldsign.CustomFieldApi(api_client)
	
    embedded_custom_field_created = custom_field_api.embed_custom_field(brand_id="YOUR_BRAND_ID")
<?php require_once "vendor/autoload.php";

use BoldSign\Configuration;
use BoldSign\Api\CustomFieldApi;

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

$custom_field_api = new CustomFieldApi($config);
$embedded_custom_field_created = $custom_field_api->embedCustomField($brand_id = 'YOUR_BRAND_ID');
ApiClient client = Configuration.getDefaultApiClient();  
client.setApiKey("YOUR_API_KEY");

CustomFieldApi customFieldApi = new CustomFieldApi();

OffsetDateTime linkValidTill = OffsetDateTime.parse("VALID_DATE");
EmbeddedCustomFieldCreated embeddedCustomFieldCreated = customFieldApi.embedCustomField("YOUR_BRAND_ID", linkValidTill);
import { CustomFieldApi } from "boldsign";

const customFieldApi = new CustomFieldApi();
customFieldApi.setApiKey("YOUR_API_KEY");

const embeddedCustomFieldCreated = customFieldApi.embedCustomField("YOUR_BRAND_ID");

Query parameters

BrandIdstringRequiredThe brand ID needs to be passed to generate an embedded custom field URL.
LinkValidTillstringConfigure the expiration for the generated URL. A maximum of 30 days can be assigned. The string should be in date-time format.

Example response

200 Success

{
  "createUrl": "https://app.boldsign.com/document/configure-custom-field/?brandId=8e5da275-xxxx-xxxx-xxxx-e936d8619cac_hSWgo"
}