Pigeon
Dashboard
Dashboard
  1. Forms
  • Introduction
  • Authentication
  • Using Third-Party Cloud Storage
  • Requests
    • Requests
    • Create Request
      POST
    • List Requests
      GET
    • Get Request
      GET
    • List Organization Requests
      GET
    • Update Request
      PATCH
    • Delete Request
      DELETE
    • Close Request
      POST
  • RequestItems
    • Request Items
    • Create Request Item
      POST
    • List Request Items
      GET
    • Get Request Item
      GET
    • Update Request Item
      PATCH
    • Delete Request Item
      DELETE
    • Verify Request Item
      POST
  • Documents
    • Documents
    • Get Document
      GET
    • Delete Document
      DELETE
    • List Request Documents
      GET
    • Delete Request Documents
      DELETE
    • List Request Item Documents
      GET
    • Download Document
      GET
    • Download Request Documents
      GET
    • Download Request Item Documents
      GET
  • Templates
    • Templates
    • List Templates
    • Create Template
    • Get Template
    • Update Template
    • Delete Template
    • List Organization Templates
  • Webhooks
    • Webhooks
    • Create Webhook Subscription
    • List Webhook Subscriptions
    • Get Webhook Subscription
    • Update Webhook Subscription
    • Delete Webhook Subscription
    • Get Webhook Signing Secret
  • Users
    • Get Current User
    • List Users
    • List Organization users
    • Get User
  • Contacts
    • List Contacts
    • Create or Update Contact
    • List Organization Contacts
  • Teams
    • List Teams
    • Get Team
  • ScheduledReminders
    • Create Scheduled Reminder
    • List Scheduled Reminders
    • Get Scheduled Reminder
    • Update Scheduled Reminder
    • Delete Scheduled Reminder
  • Escalations
    • Create Escalations
    • List Escalations
    • Get Escalation
    • Update Escalation
    • Delete Escalation
  • Attachments
    • List Attachments
    • Create Attachment
    • Get Attachment
  • Forms
    • Get Form
      GET
    • Delete Form
      DELETE
    • List Forms
      GET
    • Create Form
      POST
  • Schemas
    • AuthMethod
    • Body_handler_attachments_post
    • Body_handler_forms_post
    • ButtonStyle
    • CollaboratorPublic
    • ConnectionProvider
    • CreateDocGen
    • CreateDocumentField
    • CreateEscalation
    • CreateESignatureItem
    • CreateRecipientPostParams
    • CreateQuestionChoice
    • CreateQuestionItem
    • CreateRequestPostParams
    • CreateRequestItem
    • CreateScheduledNotificationRecipient
    • CreateRequestRecipient
    • CreateScheduledReminder
    • CreateTemplatePostParams
    • CreateWebhookWithoutOrg
    • CustomerDocumentPublic
    • CreatedFormPublic
    • DocumentNotFound
    • DocumentPublic
    • DocumentGroupOverride
    • DocumentType
    • DocumentWithItemPublic
    • FilenameFormat
    • FormNotFound
    • FormFieldType
    • FormFieldPublic
    • FormPublic
    • HTTPValidationError
    • HeroStyle
    • ItemType
    • Language
    • OrganizationNotFound
    • RecipientPublic
    • ItemCondition
    • RequestAttachmentPublic
    • ItemConditionPredicate
    • RequestItemNotFound
    • RequestNotFound
    • RequestPublic
    • QuestionType
    • RequestStatus
    • ScheduledNotificationNotFound
    • RequestItemPublic
    • RequestRecipientPublic
    • ScheduledNotificationPublic
    • SendMethod
    • SessionPayloadPublic
    • SortOrder
    • TeamNotFound
    • TeamPublic
    • TemplateNotFound
    • TemplatePublic
    • UpdateEscalation
    • UpdateRequestPostParams
    • UpdateScheduledNotificationRecipient
    • UpdateRequestItem
    • UpdateScheduledReminder
    • UpdateTemplate
    • UpdateWebhook
    • UserNotFound
    • UserPublic
    • UserRole
    • ValidationError
    • WebhookNotFound
    • WebhookPublic
    • WebhookPublicWithSecret
    • WebhookTopic
  1. Forms

Create Form

POST
/forms
Upload a PDF and create a Form that can be used in requests as soon as this returns. Fields are placed on the PDF and fixed text is written into it before the response.

Request

Body Params multipart/form-dataRequired

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 '/forms' \
--form 'metadata=""' \
--form 'file=@""'

Responses

🟢200OK
application/json
Successful Response
Bodyapplication/json

Example
{
    "id": "string",
    "name": "string",
    "size": 0,
    "fields": [],
    "ref_map": {
        "property1": "string",
        "property2": "string"
    }
}
🟠422Parameter Error
Previous
List Forms
Next
AuthMethod