Create Signing Field | propelone

This endpoint expects a multipart form.

widthstringRequired

Required: Field width in PDF points - numeric > 0

heightstringRequired

Required: Field height in PDF points - numeric > 0

field_typestringRequired

Required: Field type - in: SIGNATURE|INITIAL|DATE|TEXT|CHECKBOX

position_xstringRequired

Required: X coordinate in PDF points from page top-left - numeric >= 0

position_ystringRequired

Required: Y coordinate in PDF points from page top-left - numeric >= 0

field_labelstringRequired

Required: Human-readable label - max 255 chars

field_orderstringRequired

Optional: Tab-order within the page - integer >= 0

is_requiredstringRequired

Optional: Recipient must complete - boolean true|false|1|0

page_numberstringRequired

Required: PDF page number - integer >= 1

default_valuestringRequired

Optional: Default value - DATE supports literal TODAY token (auto-fills with submit-time UTC date) - max 1000 chars

document_signer_idstringRequired

Required: Owning signer UUID - exists:document_signers,id

Successful response

1	curl -X POST https://https//https/documents/%7Bdocument_id%7D/signing-fields \
2	-H "{{tenant_key_name}}: {{tenant_key_value1}}\|{{tenant_key_value2}}" \
3	-H "Content-Type: multipart/form-data" \
4	-F width="150" \
5	-F height="50" \
6	-F field_type="SIGNATURE" \
7	-F position_x="100" \
8	-F position_y="200" \
9	-F field_label="Client Signature" \
10	-F field_order="1" \
11	-F is_required="true" \
12	-F page_number="2" \
13	-F default_value="" \
14	-F document_signer_id="3fa85f64-5717-4562-b3fc-2c963f66afa6"