Update E-Signature Document

Request

Path Params

id

string

required

ID

Body Params application/json

annotations

array[object (ContractAnnotation) {4}]

optional

Dynamic fields to be displayed in document during signing session

id

string

optional

ID

type

enum<string>

required

Type of annotation

Allowed values:

stringnumberdate

defaultValue

string

optional

Default value to be displayed if annotation not overwritten.

layout

object (ContractItemLayout)

optional

Layout details for annotation placement in document.

fields

array[object (ContractFields) {5}]

optional

Fields that need to be filled in by signer

id

string

optional

ID

type

enum<string>

required

Field/input type

Allowed values:

textsignaturecheckboxradioinitialsdate

placeholder

string

optional

Placeholder value to be displayed until field receives input.

assigned_to

object (Assignee)

optional

Recipient who the field is assigned to

layout

object (ContractItemLayout)

optional

Layout details for field placement in document.

Example

{
    "annotations": [
        {
            "id": "string",
            "type": "string",
            "defaultValue": "string",
            "layout": {
                "page": 0,
                "position": {
                    "offset_x": 0,
                    "offset_y": 0,
                    "anchor_point": "TOP_LEFT"
                },
                "style": {
                    "width": 0,
                    "height": 0
                }
            }
        }
    ],
    "fields": [
        {
            "id": "string",
            "type": "text",
            "placeholder": "string",
            "assigned_to": {
                "email": "string",
                "firstName": "string",
                "lastName": "string",
                "phone": "string"
            },
            "layout": {
                "page": 0,
                "position": {
                    "offset_x": 0,
                    "offset_y": 0,
                    "anchor_point": "TOP_LEFT"
                },
                "style": {
                    "width": 0,
                    "height": 0
                }
            }
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request PATCH '/contracts/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "annotations": [
        {
            "id": "string",
            "type": "string",
            "defaultValue": "string",
            "layout": {
                "page": 0,
                "position": {
                    "offset_x": 0,
                    "offset_y": 0,
                    "anchor_point": "TOP_LEFT"
                },
                "style": {
                    "width": 0,
                    "height": 0
                }
            }
        }
    ],
    "fields": [
        {
            "id": "string",
            "type": "text",
            "placeholder": "string",
            "assigned_to": {
                "email": "string",
                "firstName": "string",
                "lastName": "string",
                "phone": "string"
            },
            "layout": {
                "page": 0,
                "position": {
                    "offset_x": 0,
                    "offset_y": 0,
                    "anchor_point": "TOP_LEFT"
                },
                "style": {
                    "width": 0,
                    "height": 0
                }
            }
        }
    ]
}'

Responses

🟢200Success

application/json

Body

document

object (File)

required

Document requiring e-signature

id

string

required

ID

name

string

required

File name

mime

string

required

File MIME type

annotationUrl

string <uri>

required

Open this URL in a browser to load an interactive session for adding/updating fields and annotations to document.

annotations

array[object (ContractAnnotation) {4}]

optional

Dynamic fields to be displayed in document during signing session

id

string

optional

ID

type

enum<string>

required

Type of annotation

Allowed values:

stringnumberdate

defaultValue

string

optional

Default value to be displayed if annotation not overwritten.

layout

object (ContractItemLayout)

optional

Layout details for annotation placement in document.

fields

array[object (ContractFields) {5}]

optional

Fields that need to be filled in by signer

id

string

optional

ID

type

enum<string>

required

Field/input type

Allowed values:

textsignaturecheckboxradioinitialsdate

placeholder

string

optional

Placeholder value to be displayed until field receives input.

assigned_to

object (Assignee)

optional

Recipient who the field is assigned to

layout

object (ContractItemLayout)

optional

Layout details for field placement in document.

Example

{
    "document": {
        "id": "72b56275-0406-4b07-bd72-33c93e5c41ba",
        "name": "Contract.pdf",
        "mime": "application/pdf"
    },
    "annotationUrl": "https://app.pigeondocuments.com/doc/xzvcxjdsf2341masf134kadsf",
    "annotations": [
        {
            "type": "string",
            "defaultValue": "reprehenderit mollit",
            "layout": {
                "page": 0,
                "position": {
                    "offset_x": 39379263.16080177,
                    "offset_y": -49145305.34637627,
                    "anchor_point": "BOTTOM_RIGHT"
                },
                "style": {
                    "width": -45250257,
                    "height": -17069010
                }
            }
        }
    ],
    "fields": [
        {
            "type": "date",
            "placeholder": "ex sit",
            "assigned_to": {
                "email": "Lauretta.Wyman@gmail.com",
                "firstName": "Zoey",
                "lastName": "Dickinson"
            },
            "layout": {
                "page": 0,
                "position": {
                    "offset_x": 40987757.80919403,
                    "offset_y": -69707507.49341482,
                    "anchor_point": "TOP_RIGHT"
                },
                "style": {
                    "width": -44235724,
                    "height": -57695917
                }
            }
        },
        {
            "type": "checkbox",
            "placeholder": "do laborum Ut amet adipisicing",
            "assigned_to": {
                "email": "Joan27@yahoo.com",
                "firstName": "Ruthie",
                "lastName": "Roob"
            },
            "layout": {
                "page": 0,
                "position": {
                    "offset_x": 24922849.067823008,
                    "offset_y": 61726760.98838478,
                    "anchor_point": "TOP_LEFT"
                },
                "style": {
                    "width": -33220728,
                    "height": -57800864
                }
            }
        },
        {
            "type": "text",
            "placeholder": "eu officia velit aliquip voluptate",
            "assigned_to": {
                "email": "Bryce.Wintheiser12@gmail.com",
                "firstName": "Cali",
                "lastName": "Gerhold"
            },
            "layout": {
                "page": 0,
                "position": {
                    "offset_x": 59820167.95741868,
                    "offset_y": -6705298.007408485,
                    "anchor_point": "TOP_RIGHT"
                },
                "style": {
                    "width": 60041296,
                    "height": -640767
                }
            }
        }
    ]
}

🟠400Bad Request

🟠404Record Not Found