Edit Document Recipient

PATCH

/documents/{id}/recipients/recipient/{recipient_id}

Edit document recipient's details

Request

Path Params

Body Params application/json

Example

{
    "email": "user01@pigeondocuments.com",
    "phone": "+14842634627",
    "delivery_methods": {
        "email": true,
        "sms": false
    },
    "first_name": "John",
    "last_name": "Doe",
    "company": "John Doe Inc.",
    "job_title": "CTO",
    "state": "Texas",
    "street_address": "1313 Mockingbird Lane",
    "city": "Austin",
    "postal_code": "75001",
    "verification_settings": {
        "verification_place": "before_open",
        "passcode_verification": {
            "passcode": "SimpleCode1"
        },
        "phone_verification": {
            "phone_number": "+1234567890"
        }
    },
    "redirect": {
        "is_enabled": true,
        "url": "https://example.com"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH '/documents/BhVzRcxH9Z2LgfPPGXFUBa/recipients/recipient/tf5dGS3Tmu3cj228ao6fnc' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "user01@pigeondocuments.com",
    "phone": "+14842634627",
    "delivery_methods": {
        "email": true,
        "sms": false
    },
    "first_name": "John",
    "last_name": "Doe",
    "company": "John Doe Inc.",
    "job_title": "CTO",
    "state": "Texas",
    "street_address": "1313 Mockingbird Lane",
    "city": "Austin",
    "postal_code": "75001",
    "verification_settings": {
        "verification_place": "before_open",
        "passcode_verification": {
            "passcode": "SimpleCode1"
        },
        "phone_verification": {
            "phone_number": "+1234567890"
        }
    },
    "redirect": {
        "is_enabled": true,
        "url": "https://example.com"
    }
}'

Responses

🟢204No Content

application/json

No content

Body

Example

{}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠429429

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

Add Document Recipient

Delete Document Recipient