Embedded Custom Field Create URL
post/v1/customField/createEmbeddedCustomFieldUrlThis 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 client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Post, "https://api.boldsign.com/v1/customField/createEmbeddedCustomFieldUrl?BrandId={brandId}&LinkValidTill=2023-05-06T09%3A12%3A28Z"); request.Headers.Add("Accept", "application/json"); request.Headers.Add("Authorization", "{{apiKey}}"); var response = await client.SendAsync(request); response.EnsureSuccessStatusCode(); Console.WriteLine(await response.Content.ReadAsStringAsync());
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_fields_response = custom_field_api.embed_custom_field(brand_id="YOUR_BRAND_ID", link_valid_till="2023-05-06T09%3A12%3A28Z")
<?php require_once "vendor/autoload.php"; $config = new BoldSign\Configuration(); $config->setApiKey('YOUR_API_KEY'); $custom_field_api = new BoldSign\Api\CustomFieldApi($config); $embedded_custom_fields_response = $custom_field_api->embedCustomField($brand_id = 'YOUR_BRAND_ID', $link_valid_till = '2023-05-06T09%3A12%3A28Z');
ApiClient client = Configuration.getDefaultApiClient(); client.setApiKey("YOUR_API_KEY"); CustomFieldApi customFieldApi = new CustomFieldApi(); OffsetDateTime linkValidTill = OffsetDateTime.parse("2025-12-31T23:59:59+00:00"); EmbeddedCustomFieldCreated embeddedCustomFieldResponse = customFieldApi.embedCustomField("YOUR_BRAND_ID", linkValidTill);
import { CustomFieldApi } from "@boldsign/node-sdk"; const customFieldApi = new CustomFieldApi(); customFieldApi.setApiKey("YOUR_API_KEY"); const linkValidTill: string = "2025-02-22"; const embeddedCustomFieldResponse = customFieldApi.embedCustomField("YOUR_BRAND_ID",new Date(linkValidTill));
Query parameters
BrandIdstringRequired | The brand ID needs to be passed to generate an embedded custom field URL. |
LinkValidTillstring | Configure 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" }