v3.0.0

Tue, 25 Jan, 2022

Breaking changes

  • The Name property is now deprecated. Use Id in the FormField property instead.

Previous

// removed code for brevity
var formfield = new FormField(name: "name");
curl -X POST 'https://api.boldsign.com/v1/document/send' \
-H 'X-API-KEY: {your-api-key}' \
-F 'Signers[0][FormFields][0][Name]=Name'  # removed code for brevity

Now

// removed code for brevity
var formfield = new FormField(id: "unique_id");
curl -X POST 'https://api.boldsign.com/v1/document/send' \
-H 'X-API-KEY: {your-api-key}' \
-F 'Signers[0][FormFields][0][Id]=unique_id' \  # removed code for brevity
  • The Name property has been removed. Use Id in the ExistingFormField property instead.

Previous

// removed code for brevity
var existingFormField = new ExistingFormField(name: "unique_id");
curl -X POST 'https://api.boldsign.com/v1/template/send?templateId=aa74e915-76cf-4a6c-bf01-3e3f1855f235' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-API-KEY: {your-api-key}' \
-d '{ "roles": ["existingFormFields": [{"name":"name",value:"value"}]]}' # removed code for brevity

Now

// removed code for brevity
var existingFormField = new ExistingFormField(id: "unique_id");
curl -X POST 'https://api.boldsign.com/v1/template/send?templateId=aa74e915-76cf-4a6c-bf01-3e3f1855f235' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-API-KEY: {your-api-key}' \
-d '{ "roles": ["existingFormFields": [{"id":"unique_id",value:"value"}]]}' # removed code for brevity