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

Create Document

POST
/documents
You have two options to create a document from file:
1.
Upload a local file. For this, use the multipart/form-data request type.
2.
Send a public URL in the document creation request like this:
curl --request POST 'https://api.pigeondocuments.com/documents' \
--header 'Content-Type: application/json' \
--data-raw '{
  "name": "Example document",
  "url": "https://www.example.com/example.pdf",
  "recipients": [
      {
      "email":"jane.doe@example.com",
      "role": "user"
      }
  ],
  "parse_form_fields": false
}'

Request

Query 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 POST '/documents?editor_ver=ev2' \
--form 'file=@""' \
--form 'data=""'

Responses

🟢201Created
application/json
OK
Body

Example
{
    "id": "D3okRfgHRX7NEhavcACReB",
    "name": "Document from Template",
    "status": "document.uploaded",
    "date_created": "2024-07-04T19:27:14.927317Z",
    "date_modified": "2024-07-04T19:27:14.927317Z",
    "expiration_date": null,
    "version": null,
    "uuid": "D3okRfgHRX7NEhavcACReB",
    "links": [
        {
            "rel": "status",
            "href": "https://api.pigeondocuments.com/documents/D3okRfgHRX7NEhavcACReB",
            "type": "GET"
        }
    ],
    "info_message": "You need to poll the Document Status method until the status will be changed to document.draft"
}
🟠400Bad Request
🟠401Unauthorized
🟠429429
Modified at 2024-09-18 02:06:43
Previous
List Documents
Next
Get Document Status