Pigeon // E-Sign
    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
    • Schemas
      • Sample Schemas
        • Pet
        • Category
        • Tag
      • Schemas
        • BulkSendList
        • BulkSendItem
        • OrganizationBranding
        • CloudStorageServices
        • CloudStorageProvider
        • DocumentGenerationFormField
        • OAuth2CreateAccessTokenRequest
        • OAuth2RefreshAccessTokenRequests
        • OAuth2AccessTokenResponse
        • DocumentListResponse
        • DocumentCreateByTemplateRequest
        • DocumentCreateByPdfRequest
        • DocumentCreateRequest
        • DocumentCreateResponse
        • DocumentStatusResponse
        • DocumentUpdateRequest
        • DocumentStatusChangeRequest
        • DocumentDetailsResponse
        • DocumentCreateLinkRequest
        • DocumentCreateLinkResponse
        • DocumentSendRequest
        • DocumentSendResponse
        • DocumentAttachmentRequest
        • DocumentAttachmentResponse
        • DocumentTransferOwnershipRequest
        • DocumentTransferAllOwnershipRequest
        • DocumentRecipientCreateRequest
        • DocumentRecipientEditRequest
        • DocumentRecipientResponse
        • TemplateListResponse
        • TemplateDetailsResponse
        • ContactDetailsResponse
        • ContactListResponse
        • ContactCreateRequest
        • ContactUpdateRequest
        • MemberDetailsResponse
        • MemberListResponse
        • DocumentStatusEnum
        • DocumentStatusRequestEnum
        • DocumentOrderingFieldsEnum
        • Field
        • CreateDocumentActor
        • Recipient
        • RecipientGroup
        • Recipient
        • RecipientGroup
        • BaseField
        • Checkbox
        • Collect File
        • Date
        • Dropdown
        • Initials
        • Radio Buttons
        • Signature
        • Stamp
        • Text
        • Recipient
        • Recipient Group
        • WebhookSubscriptionPayloadEnum
        • WebhookSubscriptionTriggerEnum
        • WebhookSubscriptionStatusEnum
        • WebhookSubscriptionCreateRequest
        • WebhookSubscriptionPatchRequest
        • WebhookSubscriptionItemResponse
        • WebhookSubscriptionSharedKeyResponse
        • WebhookSubscriptionListResponse
        • WebhookEventErrorEnum
        • WebhookEventHttpStatusCodeGroupEnum
        • WebhookEventTriggerEnum
        • WebhookEventItemResponse
        • WebhookEventDetailsResponse
        • WebhookEventPageResponse
        • UploadSectionByPdfRequest
        • UploadSectionByTemplateRequest
        • UploadSectionRequest
        • UploadSectionListResponse
        • UploadSectionResponse
        • UploadSectionStatusResponse
        • UploadSectionStatusEnum
        • SectionInfoResponse
        • RecipientVerificationSettings
        • RecipientRedirect
        • RecipientDeliveryMethods
        • CreateWorkspaceRequest
        • CreateWorkspaceResponse
        • CreateUserRequest
        • CreateUserResponse
        • AddMemberRequest
        • AddMemberResponse
        • ListUsersResponse
        • ListWorkspacesResponse
        • Recipient
        • Recipient Group
      • Response
        • 401
        • 403
        • 404
        • 409
        • 429
        • 400RequestError
        • 400ValidationError

    Introduction

    Pigeon E-Signature API#

    Pigeon is an all-in-one platform for fast, safe, & streamlined document collection. Pigeon provides best-in-class e-signature functionality and fully-featured automation functionality to enable seamless document collection processes inside your product.

    API Reference#

    The Pigeon API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

    API Host#

    The Pigeon API is available at:
    https://api.pigeondocuments.com

    API Endpoints#

    For documentation on specific API endpoints and functionalities, use the navigation menu or search.
    Modified at 2024-09-18 00:03:31
    Next
    Authentication