Create Document Fields

POST

/documents/{id}/fields

Creates fields for a particular document

Request

Path Params

Body Params application/json

Example

{
    "fields": [
        {
            "field_id": "string",
            "type": "text",
            "placeholder": "string",
            "assigned_to": "string",
            "layout": {
                "page": 0,
                "position": {
                    "offset_x": 0,
                    "offset_y": 0,
                    "anchor_point": "topleft"
                },
                "style": {
                    "width": 0,
                    "height": 0
                }
            }
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/documents/BhVzRcxH9Z2LgfPPGXFUBa/fields' \
--header 'Content-Type: application/json' \
--data-raw '{
    "fields": [
        {
            "field_id": "string",
            "type": "text",
            "placeholder": "string",
            "assigned_to": "string",
            "layout": {
                "page": 0,
                "position": {
                    "offset_x": 0,
                    "offset_y": 0,
                    "anchor_point": "topleft"
                },
                "style": {
                    "width": 0,
                    "height": 0
                }
            }
        }
    ]
}'

Responses

🟢200OK

application/json

Body

Example

{
    "fields": [
        {}
    ]
}

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🟠429429

Modified at 2024-09-17 17:05:10

List Document Fields

Add Document Recipient