Form fields
Save Form Fields
Create or replace form fields on a document. Document must be in `draft` status. Supported field types: `text`, `textarea`, `email`, `number`, `date`, `checkbox`, `radio`, `dropdown`, `signature`.
Create or replace form fields on a document. Document must be in draft status.
Supported field types: text, textarea, email, number, date, checkbox, radio, dropdown, signature.
Authorization
bearerAuth AuthorizationBearer <token>
API key as Bearer token. Format: signsecure_xxxxxxxx...
In: header
Path Parameters
documentId*string
The document ID
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://api.signsecure.com/api/v1/documents/string/fields" \ -H "Content-Type: application/json" \ -d '{ "fields": [ { "type": "text", "fieldKey": "string", "pageNumber": 0, "x": 0, "y": 0, "width": 0, "height": 0 } ] }'{
"message": "string",
"fields": [
{
"id": "string",
"type": "text",
"fieldKey": "string",
"pageNumber": 0,
"x": 0,
"y": 0,
"width": 0,
"height": 0,
"label": "string",
"required": true,
"readOnly": true,
"recipientId": "string",
"defaultValue": null,
"placeholder": "string",
"options": [
"string"
],
"validation": {},
"multiline": true,
"showLabel": true,
"radioGroup": {}
}
],
"total": 0
}{
"code": "VALIDATION_ERROR",
"message": "fields.0.type: Invalid enum value",
"requestId": "req_abc123",
"timestamp": "2026-03-11T10:30:00.000Z",
"details": {
"validation": {
"fieldErrors": {
"fields.0.type": [
"Invalid enum value"
]
},
"formErrors": [],
"issues": [
{
"path": "fields.0.type",
"message": "Invalid enum value",
"code": "invalid_enum_value"
}
]
}
}
}{
"code": "UNAUTHORIZED",
"message": "Invalid or missing API key",
"requestId": "req_abc123",
"timestamp": "2026-03-11T10:30:00.000Z"
}{
"code": "FORBIDDEN",
"message": "API key is disabled",
"requestId": "req_abc123",
"timestamp": "2026-03-11T10:30:00.000Z"
}{
"code": "NOT_FOUND",
"message": "Document not found",
"requestId": "req_abc123",
"timestamp": "2026-03-11T10:30:00.000Z"
}{
"code": "INTERNAL_SERVER_ERROR",
"message": "An internal error occurred",
"requestId": "req_abc123",
"timestamp": "2026-03-11T10:30:00.000Z"
}