API Reference
Status PageRoadmapTestimoniesShare feedback

Create a new Field on a Document

post
https://api-sandbox.yousign.app/v3/signature_requests//documents//fields

Adds a Field to a given Document.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

Signature Request Id

uuid
required

Document ID

Body Params
uuid
required
string
enum
required
Allowed:
integer
required
≥ 1
integer
required
0 to 32767
integer
required
0 to 32767
integer
37 to 1000

Default value is 37

integer
85 to 2000

Default value is 85

string | null

Provide extra context to explain why the Document is being signed. Once the Document is signed, the custom reason is stored in the Audit Trail and is included in the signature certificate.

The default value is: "Signed by [Signer first name] [Signer last name]".

This parameter is only available for users with a pro or scale plan.

display

Controls what is shown within the signature field.

Responses

Updated 7 days ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 days ago