@firma-dev/sdk
import { FirmaClient } from "@firma-dev/sdk";
const firma = new FirmaClient({ apiKey: "YOUR_API_KEY" });
const response = await firma.customFields.updateWorkspaceCustomField({
workspace_id: "workspace_id",
field_id: "field_id"
});
console.log(response);curl --request PUT \
--url https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/custom-fields/{field_id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"field_label": "<string>",
"is_preset": true,
"preset_value": "<string>"
}
'import requests
url = "https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/custom-fields/{field_id}"
payload = {
"field_label": "<string>",
"is_preset": True,
"preset_value": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({field_label: '<string>', is_preset: true, preset_value: '<string>'})
};
fetch('https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/custom-fields/{field_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/custom-fields/{field_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'field_label' => '<string>',
'is_preset' => true,
'preset_value' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/custom-fields/{field_id}"
payload := strings.NewReader("{\n \"field_label\": \"<string>\",\n \"is_preset\": true,\n \"preset_value\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/custom-fields/{field_id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"field_label\": \"<string>\",\n \"is_preset\": true,\n \"preset_value\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/custom-fields/{field_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"field_label\": \"<string>\",\n \"is_preset\": true,\n \"preset_value\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"field_name": "<string>",
"field_label": "<string>",
"is_preset": true,
"preset_value": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"error": "Validation Error",
"message": "Invalid input data",
"details": {
"name": "Name is required",
"email": "Invalid email format"
}
}{
"error": "Unauthorized",
"message": "Invalid API key"
}{
"error": "Not Found",
"message": "The requested resource was not found"
}{
"error": "<string>",
"message": "<string>",
"details": {}
}Custom Fields
Update workspace custom field
Update an existing custom field definition
PUT
/
workspace
/
{workspace_id}
/
custom-fields
/
{field_id}
@firma-dev/sdk
import { FirmaClient } from "@firma-dev/sdk";
const firma = new FirmaClient({ apiKey: "YOUR_API_KEY" });
const response = await firma.customFields.updateWorkspaceCustomField({
workspace_id: "workspace_id",
field_id: "field_id"
});
console.log(response);curl --request PUT \
--url https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/custom-fields/{field_id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"field_label": "<string>",
"is_preset": true,
"preset_value": "<string>"
}
'import requests
url = "https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/custom-fields/{field_id}"
payload = {
"field_label": "<string>",
"is_preset": True,
"preset_value": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({field_label: '<string>', is_preset: true, preset_value: '<string>'})
};
fetch('https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/custom-fields/{field_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/custom-fields/{field_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'field_label' => '<string>',
'is_preset' => true,
'preset_value' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/custom-fields/{field_id}"
payload := strings.NewReader("{\n \"field_label\": \"<string>\",\n \"is_preset\": true,\n \"preset_value\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/custom-fields/{field_id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"field_label\": \"<string>\",\n \"is_preset\": true,\n \"preset_value\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/custom-fields/{field_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"field_label\": \"<string>\",\n \"is_preset\": true,\n \"preset_value\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"field_name": "<string>",
"field_label": "<string>",
"is_preset": true,
"preset_value": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"error": "Validation Error",
"message": "Invalid input data",
"details": {
"name": "Name is required",
"email": "Invalid email format"
}
}{
"error": "Unauthorized",
"message": "Invalid API key"
}{
"error": "Not Found",
"message": "The requested resource was not found"
}{
"error": "<string>",
"message": "<string>",
"details": {}
}Authorizations
API key for authentication. Use your API key directly without any prefix (e.g., 'your-api-key'). Bearer prefix is optional but not required.
Body
application/json
Response
Custom field updated successfully
A custom field definition for a workspace
Unique identifier
Machine-readable field name (auto-generated from label)
Human-readable display label
If true, this field has a preset value for all users
Preset value (only used when is_preset=true)
Was this page helpful?
⌘I