Pigeon // E-Sign
  1. Documents
Pigeon // E-Sign
  • Introduction
  • Authentication
  • Integrations
  • Documents
    • List Documents
      GET
    • Create Document
      POST
    • Get Document Status
      GET
    • Delete Document
      DELETE
    • Update Document
      PATCH
    • Update Document Status
      PATCH
    • Move Document to Draft
      POST
    • Get Document Details
      GET
    • Send Document
      POST
    • Create Document Session
      POST
    • Download Document
      GET
    • Download Protected Document
      GET
    • Update Document Ownership
      PATCH
    • Transfer Documents Ownership
      PATCH
  • Document Attachments
    • Document Attachment List
      GET
    • Document Attachment Create
      POST
    • Document Attachment Details
      GET
    • Document Attachment Delete
      DELETE
    • Document Attachment Download
      GET
  • Document Generation
    • List Document Fields
      GET
    • Create Document Fields
      POST
  • Document Recipients
    • Add Document Recipient
      POST
    • Edit Document Recipient
      PATCH
    • Delete Document Recipient
      DELETE
    • Reassign Document Recipient
      POST
  • Bulk Send
    • Trigger Bulk Send
    • Create Bulk Send List
    • Get Bulk Send List
    • Get Bulk Send Lists
    • Update Bulk Send List
    • Delete Bulk Send List
  • Templates
    • List Templates
    • Create Template
    • Template Details
    • Delete Template
  • Cloud Storage
    • List Cloud Storage Providers
    • Connect Cloud Storage Providers
    • Disconnect Cloud Storage Provider
  • Webhooks
    • Get all webhook subscriptions
    • Create webhook subscription
    • Get webhook subscription by uuid
    • Update webhook subscription
    • Delete webhook subscription
  • Branding
    • Get Organization Branding
    • Update Organization Branding
  • Confirmation Page
    • Enable/Disable Signature Confirmation Page
  1. Documents

Update Document Status

PATCH
/documents/{id}/status

Document statuses#

Completed - document.completed - API code 1
Expired - document.voided - code 2
Declined - document.declined - code 3

Request

Path Params

Body Params multipart/form-data

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PATCH '/documents/iGsFiaV2hEEvQdhr2WAkMk/status' \
--form 'file=@""' \
--form 'data=""'

Responses

🟢204No Content
application/json
No content
Body

Example
{}
🟠401Unauthorized
🟠403Forbidden
🟠404Record Not Found
🟠409409
🟠429429
Modified at 2024-09-18 01:29:53
Previous
Update Document
Next
Move Document to Draft