Custom Fields

Update workspace custom field

Update an existing custom field definition

put/workspace/{workspace_id}/custom-fields/{field_id}

Request

Base URL
https://api.firma.dev/functions/v1/signing-request-api
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/firma/apis/firma-partner-api/docs/workspace/:workspace_id/custom-fields/:field_id/put.ts
A function with typed inputs. Its response is checked against the schema.

workspace_idstring uuid required

field_idstring uuid required

field_labelstring

is_presetboolean

preset_valuestring

Custom field updated successfully

idstring uuid required

Unique identifier

field_namestring required

Machine-readable field name (auto-generated from label)

field_labelstring required

Human-readable display label

is_presetboolean

If true, this field has a preset value for all users

preset_valuestring nullable

Preset value (only used when is_preset=true)

created_atstring date-time

updated_atstring date-time

No recorded changes to this operation across all 13 revisions of this API.