Pigeon
  1. Requests
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. Requests

Duplicate Request

POST
/requests/{id}/duplicate
Creates a new document collection request as a duplicate of a pre-existing request. Supports overriding of any pre-existing values.

Request

Path Params
id
string 
required
Body Params application/json
title
string 
optional
Title of the request. Required unless template_id is set. Overwrites template title when set.
items
array[object (RequestItem) {9}] 
optional
Items included in the request. Required unless template_id is set. Overwrites template title when set.
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> 
optional
Status of the request item.
Allowed values:
INCOMPLETEPARTIALLY_SUBMITTEDREJECTEDCOMPLETEDVERIFIEDEXPIREDCLOSED
required
boolean 
required
Indicates whether the recipient is required to complete the request item.
Default:
false
question
object (QuestionItem) 
optional
Question item details. Set when type = "QUESTION"
eSignature
object (ESignatureItem) 
optional
E-Signature item details. Set when type = "E_SIGNATURE"
attachments
array[object (RequestItemAttachment) {3}] 
optional
Files attached to the request item, commonly used to display helpful information for completing the request.
assignedTo
object (Assignee) 
optional
Recipient who the item is assigned to
recipients
object (Recipient) 
required
email
string 
optional
Email of the recipient. Required if phoneNum not set.
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. Required if email not set.
authMethod
object (AuthenticationMethod) 
optional
Method used to authenticate recipient
sendMethod
enum<string> 
optional
How recipient will receive request notifications. Defaults to e-mail.
Allowed values:
DEFAULTEMAILSMSBOTHMULTIPLE
completionOrder
number 
optional
Order that recipient must complete request in. Must be positive integer and must form complete, sequential list with remaining recipients.
from
integer 
optional
ID of user who is making the request. Defaults to currently authenticated user.
collaborators
array[integer]
optional
Collaborators receive email updates related to request lifecycle and have limited edit access to the request.
customMessage
string 
optional
Custom message displayed to recipient when viewing the request.
reminderInterval
integer 
optional
Interval at which recipients will receive reminder notifications to complete request, measure in days (ie 7 = 'every week')
>= 0
dueDate
string <date-time>
optional
Date when request must be completed by.
deletionDate
string <date-time>
optional
Date when request and all submitted documents will be deleted. Must be greater than (later than) due date. Defaults to organizational settings.
sendMethod
enum<string> 
optional
How recipients will receive request notifications. Defaults to e-mail.
Allowed values:
DEFAULTEMAILSMSBOTHMULTIPLE
language
enum<string> 
optional
Defaults to English (en)
Allowed values:
en-USesarzhfrdehtheiditkoptparu
skipInitialNotification
boolean 
optional
If true, does not send initial notificiation out to recipients when request is created. Defaults to false.
sendTogether
boolean 
optional
Indicates whether the request needs to be filled out by each recipient separately (false) or if all recipients can fill out a single verson of the request (true). Defaults to false.
Example
{
  "title": "string",
  "items": [
    {
      "type": "STANDARD",
      "name": "string",
      "description": "string",
      "status": "INCOMPLETE",
      "required": false,
      "question": {
        "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"
      }
    }
  ],
  "recipients": {
    "email": "string",
    "firstName": "string",
    "lastName": "string",
    "phone": "string",
    "authMethod": {
      "type": "EMAIL_ACCESS_CODE",
      "questionText": "string",
      "questionAnswer": "string"
    },
    "sendMethod": "DEFAULT",
    "completionOrder": 0
  },
  "from": 0,
  "collaborators": [
    0
  ],
  "customMessage": "string",
  "reminderInterval": 0,
  "dueDate": "2019-08-24T14:15:22Z",
  "deletionDate": "2019-08-24T14:15:22Z",
  "sendMethod": "DEFAULT",
  "language": "en-US",
  "skipInitialNotification": true,
  "sendTogether": 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//duplicate' \
--header 'Content-Type: application/json' \
--data-raw '{
    "title": "string",
    "items": [
        {
            "type": "STANDARD",
            "name": "string",
            "description": "string",
            "status": "INCOMPLETE",
            "required": false,
            "question": {
                "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"
            }
        }
    ],
    "recipients": {
        "email": "string",
        "firstName": "string",
        "lastName": "string",
        "phone": "string",
        "authMethod": {
            "type": "EMAIL_ACCESS_CODE",
            "questionText": "string",
            "questionAnswer": "string"
        },
        "sendMethod": "DEFAULT",
        "completionOrder": 0
    },
    "from": 0,
    "collaborators": [
        0
    ],
    "customMessage": "string",
    "reminderInterval": 0,
    "dueDate": "2019-08-24T14:15:22Z",
    "deletionDate": "2019-08-24T14:15:22Z",
    "sendMethod": "DEFAULT",
    "language": "en-US",
    "skipInitialNotification": true,
    "sendTogether": true
}'

Responses

🟢201Created
application/json
Body
id
string 
required
ID
title
string 
required
Title of request
status
enum<string> 
required
Status of request. Primary indicator of request's completion status.
Allowed values:
INCOMPLETEPARTIALLY_SUBMITTEDREJECTEDCOMPLETEDVERIFIEDEXPIREDCLOSED
items
array[object (RequestItem) {9}] 
required
Items included in request
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> 
optional
Status of the request item.
Allowed values:
INCOMPLETEPARTIALLY_SUBMITTEDREJECTEDCOMPLETEDVERIFIEDEXPIREDCLOSED
required
boolean 
required
Indicates whether the recipient is required to complete the request item.
Default:
false
question
object (QuestionItem) 
optional
Question item details. Set when type = "QUESTION"
eSignature
object (ESignatureItem) 
optional
E-Signature item details. Set when type = "E_SIGNATURE"
attachments
array[object (RequestItemAttachment) {3}] 
optional
Files attached to the request item, commonly used to display helpful information for completing the request.
assignedTo
object (Assignee) 
optional
Recipient who the item is assigned to
recipients
array[object (Recipient) {7}] 
required
Recipients of request
email
string 
optional
Email of the recipient. Required if phoneNum not set.
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. Required if email not set.
authMethod
object (AuthenticationMethod) 
optional
Method used to authenticate recipient
sendMethod
enum<string> 
optional
How recipient will receive request notifications. Defaults to e-mail.
Allowed values:
DEFAULTEMAILSMSBOTHMULTIPLE
completionOrder
number 
optional
Order that recipient must complete request in. Must be positive integer and must form complete, sequential list with remaining recipients.
links
array[object (RecipientLink) {2}] 
required
Link(s) used by recipients to complete requests.
email
string 
required
Email of recipient, used here to uniquely identify recipient
link
string <uri>
required
Link that recipient can use to complete the request
templateId
integer 
optional
Identifer of template used to create request (if applicable).
from
object (User) 
optional
ID of User making the request.
id
string 
required
ID
firstName
string 
required
lastName
string 
required
email
string 
required
role
enum<string> 
required
Allowed values:
USERADMIN
collaborators
array[object (User) {5}] 
optional
Collaborators receive email updates related to request lifecycle and have limited edit access to the request.
id
string 
required
ID
firstName
string 
required
lastName
string 
required
email
string 
required
role
enum<string> 
required
Allowed values:
USERADMIN
customMessage
string 
optional
Custom message displayed to recipient when viewing the request.
draft
boolean 
optional
Indicates that request is in a "draft" state. When true, request will not be sent to recipients. Defaults to false
Default:
false
reminderInterval
number 
required
Interval at which recipients will receive reminder notifications to complete request, measure in days (ie 7 = 'every week')
dueDate
string <date-time>
optional
Date when request must be completed by
deletionDate
string <date-time>
optional
Date when request and all submitted documents will be deleted. Must be greater than (later than) due date. Defaults to organizational settings.
sendMethod
enum<string> 
required
How recipients will receive request notifications.
Allowed values:
DEFAULTEMAILSMSBOTHMULTIPLE
language
enum<string> 
required
Allowed values:
en-USesarzhfrdehtheiditkoptparu
sendTogether
boolean 
optional
Indicates whether the request needs to be filled out by each recipient separately (false) or if all recipients will collaborate on a single request (true). Defaults to false.
unread
boolean 
required
Indicates whether the request has been viewed in the Pigeon dashboard. By defauly, set to true on creation and updates to false when viewed.
createdAt
string <date-time>
required
Request creation time
updatedAt
string <date-time>
required
Timestamp of most recent request update
completionOrder
boolean 
required
Whether or not completion order is enabled for this request, which enforces the order that recipients can complete their assigned request items.
sendAt
string <date-time>
optional
Scheduled time when request should be sent out to all recipients
Example
{
    "id": "voluptate ea",
    "title": "derelinquo comptus ager",
    "status": "INCOMPLETE",
    "items": [
        {
            "type": "QUESTION",
            "name": "urbs adipisci sophismata",
            "description": "Talio tergiversatio corroboro creber brevis deporto. Peccatus deduco supra adeptio. Speciosus vesica ciminatio tersus.",
            "required": false
        }
    ],
    "recipients": [
        {
            "email": "Haylie93@hotmail.com",
            "firstName": "Elbert",
            "lastName": "Hickle",
            "phoneNum": "686-222-4882 x7685",
            "authMethod": {
                "type": "SMS_ACCESS_CODE",
            }
        },
        {
            "email": "Claire.Wilderman27@yahoo.com",
            "firstName": "Elissa",
            "lastName": "Ullrich",
            "phoneNum": "446-661-5018 x8184",
            "authMethod": {
                "type": "QUESTION",
                "questionText": "consectetur",
                "questionAnswer": "aliquip consequat eu eiusmod consectetur"
            }
        }
    ],
    "links": [
        {
            "email": "Haylie93@hotmail.com",
            "link": "https://tiny-tool.org/"
        },
        {
            "email": "Claire.Wilderman27@yahoo.com",
            "link": "https://friendly-ravioli.org"
        }
    ],
    "from": {
        "id": "dolore ex esse",
        "firstName": "Maxine",
        "lastName": "Pollich",
        "email": "Rylee_Spencer@gmail.com"
    },
    "collaborators": [
        {
            "id": "occaecat pariatur sint dolor",
            "firstName": "Tomasa",
            "lastName": "Gislason",
            "email": "Mark57@gmail.com"
        }
    ],
    "customMessage": "Blandior arx thesis odit deleo ter. Angulus complectus nihil atque volup blandior. Corporis cibus cubo terra.",
    "reminderInterval": 7,
    "dueDate": "2024-10-01T05:12:41.158Z",
    "deletionDate": "2024-10-01T04:55:11.739Z",
    "sendMethod": "EMAIL",
    "language": "en"
}
🟠404Record Not Found
🟠400Bad Request
Modified at 2024-10-29 16:09:42
Previous
Close Request
Next
Reject Request (Request Changes)