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 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 requests

url = "https://api.boldsign.com/v1/customField/createEmbeddedCustomFieldUrl?BrandId={brandId}&LinkValidTill=2023-05-06T09%3A12%3A28Z"

payload = {}
headers = {
  'Accept': 'application/json',
  'Authorization': '{{apiKey}}'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

const axios = require('axios');

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'https://api.boldsign.com/v1/customField/createEmbeddedCustomFieldUrl?BrandId={brandId}&LinkValidTill=2023-05-06T09%3A12%3A28Z',
  headers: { 
    'Accept': 'application/json', 
    'Authorization': '{{apiKey}}'
  }
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

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"
}