Pigeon
  1. Request Items
Pigeon
  • Introduction
  • Authentication
  • Integrations
  • Webhooks
  • Guides
    • How To Share Files via Pigeon
    • How To Create an E-Signature Request Item
    • How To Send Emails from Organization Addresses
  • Requests
    • Create Request
      POST
    • List Requests
      GET
    • Get Request
      GET
    • Delete Request
      DELETE
    • Update Request
      PATCH
    • Verify Request
      POST
    • Close Request
      POST
    • Duplicate Request
      POST
    • Reject Request (Request Changes)
      POST
    • Send Request Reminder
      POST
    • List Request Reminders
      GET
    • Get Request Activity Log
      GET
    • List Organization Requests
      GET
    • Update Request
      PATCH
    • Delete Request
      DELETE
  • Request Items
    • List Request Items
      GET
    • Get Request Item
      GET
    • Verify Request Item
      POST
    • Update Request Item
      PATCH
    • Delete Request Item
      DELETE
    • Create Request Item
      POST
  • Templates
    • Create Template
    • List Templates
    • Get Template
    • Delete Template
    • Update Template
    • List Organization Templates
  • Webhooks
    • Create Webhook Subscription
    • Get Webhook Subscription
    • List Webhook Subscriptions
    • Update Webhook Subscription
    • Delete Webhook Subscription
  • Files
    • Download Request Files
    • Download Request Item Files
    • Download File
    • Get Request Files
    • Get Request Item Files
    • Delete File
  • Request Attachments
    • Upload Attachment
    • List Item Attachments
    • Get Attachment
    • Download Attachment
    • Delete Attachment
  • File Sharing
    • Initialize File Sharing Session
    • Upload File
    • Share Files
    • List File Sharing Sessions
    • Get File Sharing Session
    • Update File Sharing Session
    • Delete File Sharing Session
  • E-Signature / Document Forms
    • Create New E-Signature Document
    • Update E-Signature Document
    • Get E-Signature Document
    • List E-Signature Documents
    • Delete E-Signature Document
  • Users
    • List Users
    • Get User
    • Get Current User
  • Cloud Storage
    • List Cloud Storage Providers
    • Connect Cloud Storage Providers
    • Disconnect Cloud Storage Provider
  • Branding
    • Get Organization Branding
    • Update Organization Branding
  • Confirmation Page
    • Enable/Disable Signature Confirmation Page
  • Organization
    • Get Organization Settings
    • Update Organization Settings
  • RequestItems
    • Create Request Item
    • List Request Items
    • Get Request Item
    • Update Request Item
    • Delete Request Item
    • Verify Request Item
  • Documents
    • Get Document
    • Delete Document
    • List Request Documents
    • Delete Request Documents
    • List Request Item Documents
    • Download Document
    • Download Request Documents
    • Download Request Item Documents
  1. Request Items

Create Request Item

POST
/requests/{id}/items
Create new request item associated with specified request.

Request

Path Params
id
string 
required
ID
Body Params application/json
name
string 
required
Item name. For items with type: Question, the name is used as the question text.
>= 1 characters
type
enum<string> 
required
Type of the request item
Allowed values:
UPLOADE_SIGNATUREQUESTION
description
string 
optional
Item description
required
boolean 
optional
Indicates whether the recipient is required to complete the request item
Example
{
    "name": "string",
    "type": "UPLOAD",
    "description": "string",
    "required": true
}

Request 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 '/requests//items' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "string",
    "type": "UPLOAD",
    "description": "string",
    "required": true
}'

Responses

🟢200Success
application/json
Body
type
enum<string> 
required
Type of the request item.
Allowed values:
STANDARDE_SIGNATUREQUESTION
name
string 
required
Item name.
description
string  | null 
optional
Item description.
status
enum<string> 
required
Status of the request item.
Allowed values:
INCOMPLETECOMPLETEREJECTEDVERIFIED
required
boolean 
required
Indicates whether the recipient is required to complete the request item.
Default:
false
questions
object (QuestionItem) 
optional
Question item details. Set when type = "QUESTION"
id
string 
optional
ID
questionText
string 
required
Question text
questionAnswer
string 
optional
Question answer
eSignature
object (ESignatureItem) 
optional
E-Signature item details. Set when type = "E_SIGNATURE"
contractId
string <uuid>
required
ID of associated contract resource
annotations
array [object {2}] 
optional
Custom values for annotations specific to this request
fields
array [object {2}] 
optional
Completed fields from e-signature form.
attachments
array[object (RequestItemAttachment) {3}] 
required
Files attached to the request item, commonly used to display helpful information for completing the request.
id
string 
required
ID
name
string 
required
File name
mime
string 
required
File MIME type
assignedTo
object (Assignee) 
required
Recipient who the item is assigned to
email
string 
optional
Email of the recipient.
firstName
string 
optional
First name of the recipient.
lastName
string 
optional
First name of the recipient.
phone
string 
optional
Phone number (mobile) of the recipient.
documents
array[object (File) {3}] 
optional
Documents submitted for request item.
id
string 
required
ID
name
string 
required
File name
mime
string 
required
File MIME type
Example
{
    "type": "STANDARD",
    "name": "string",
    "description": "string",
    "status": "INCOMPLETE",
    "required": false,
    "questions": {
        "id": "string",
        "questionText": "string",
        "questionAnswer": "string"
    },
    "eSignature": {
        "contractId": "dbf32426-cf38-4818-9c6e-3230d889fa51",
        "annotations": [
            {
                "annotationId": "88801ce0-d7fe-4339-afa4-cdb9248204d4",
                "value": "string"
            }
        ],
        "fields": [
            {
                "id": "string",
                "value": "string"
            }
        ]
    },
    "attachments": [
        {
            "id": "string",
            "name": "string",
            "mime": "string"
        }
    ],
    "assignedTo": {
        "email": "string",
        "firstName": "string",
        "lastName": "string",
        "phone": "string"
    },
    "documents": [
        {
            "id": "string",
            "name": "string",
            "mime": "string"
        }
    ]
}
🟠404Record Not Found
🟠400Bad Request
Modified at 2024-10-29 16:10:10
Previous
Delete Request Item
Next
Create Template