Update Document

PATCH

/documents/{id}

Request

Path Params

Body Params application/json

Example

{
    "name": "Contract",
    "recipients": [
        {
            "id": "ZPeAfcpzr9aiVs5vqUf6jg",
            "delivery_methods": {
                "email": true,
                "sms": false
            },
            "redirect": {
                "is_enabled": true,
                "url": "https://example.com"
            },
            "type": "recipient"
        }
    ],
    "fields": {
        "Like": {
            "value": true
        },
        "Delivery": {
            "value": "Same Day Delivery"
        },
        "Date": {
            "value": "2019-12-31T00:00:00.000Z"
        }
    },
    "tokens": [
        {
            "name": "Favorite.Pet",
            "value": "Panda"
        }
    ],
    "tags": [
        "updated_via_api",
        "test_document"
    ],
    "metadata": {
        "my_favorite_pet": "Cat"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH '/documents/BhVzRcxH9Z2LgfPPGXFUBa' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Contract",
    "recipients": [
        {
            "id": "ZPeAfcpzr9aiVs5vqUf6jg",
            "delivery_methods": {
                "email": true,
                "sms": false
            },
            "redirect": {
                "is_enabled": true,
                "url": "https://example.com"
            },
            "type": "recipient"
        }
    ],
    "fields": {
        "Like": {
            "value": true
        },
        "Delivery": {
            "value": "Same Day Delivery"
        },
        "Date": {
            "value": "2019-12-31T00:00:00.000Z"
        }
    },
    "tokens": [
        {
            "name": "Favorite.Pet",
            "value": "Panda"
        }
    ],
    "tags": [
        "updated_via_api",
        "test_document"
    ],
    "metadata": {
        "my_favorite_pet": "Cat"
    }
}'

Responses

🟢204No Content

application/json

No content

Body

Example

{}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠429429

Modified at 2024-09-17 17:20:11

Delete Document

Update Document Status