Reject Request (Request Changes)

Reject submitted request items and request changes.

Request

Path Params

string

required

Request ID

Body Params application/json

items

array [object {2}]

required

Request items that changes are being requested for.

string <uuid>

required

Request Item ID

comments

string

optional

Comments indicating what changes are requested for item.

customMessage

string

optional

Custom message to display to recipient.

deleteOriginalFiles

boolean

optional

Indicates whether or not the previously uploaded files should be deleted. Only applies to items that changes were requested for (items). Defaults to false.

Example

{
  "items": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "comments": "string"
    }
  ],
  "customMessage": "string",
  "deleteOriginalFiles": true
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

string

required

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

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.

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.

string

required

firstName

string

required

lastName

string

required

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.

string

required

firstName

string

required

lastName

string

required

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": "71ae7550-865a-437a-bda2-619f50722841",
  "title": "Sample Request",
  "status": "REJECTED",
  "items": [
    {
      "type": "STANDARD",
      "name": "conatus alveus vir",
      "description": "Aer testimonium aegrotatio accendo adhaero doloribus sunt vulnus. Astrum combibo tempore. Coadunatio ducimus fuga.",
      "status": "CLOSED",
      "required": true,
      "question": {
        "id": "commodo sunt eu est sint",
        "questionText": "do ut in exercitation dolor",
        "questionAnswer": "consectetur cillum mollit exercitation"
      },
      "attachments": [
        {
          "id": "072db969-7064-41a9-a760-57bd19c3a0d5",
          "name": "occaecati amitto tamquam",
          "mime": "application/xml"
        }
      ],
      "assignee": {
        "email": "Samanta_Streich85@yahoo.com",
        "firstName": "Lesly",
        "lastName": "Wiza"
      }
    }
  ],
  "recipients": [
    {
      "email": "Pansy_Powlowski37@gmail.com",
      "firstName": "Angelita",
      "lastName": "Price",
      "phoneNum": "(571) 668-6652 x845",
      "authMethod": {
        "type": "EMAIL_ACCESS_CODE",
        "questionText": "proident ea laboris labore",
        "questionAnswer": "et anim ea nostrud"
      }
    },
    {
      "email": "Adolph.Kozey@yahoo.com",
      "firstName": "Elisa",
      "lastName": "Keeling",
      "phoneNum": "(569) 383-9514 x05921",
      "authMethod": {
        "type": "SMS_ACCESS_CODE",
        "questionText": "officia Ut in eu laborum",
        "questionAnswer": "cillum velit reprehenderit quis"
      }
    },
    {
      "email": "Alberta_Bashirian61@hotmail.com",
      "firstName": "Itzel",
      "lastName": "Murazik",
      "phoneNum": "526.680.1714 x23258",
      "authMethod": {
        "type": "SMS_ACCESS_CODE",
        "questionText": "voluptate",
        "questionAnswer": "veniam est ipsum"
      }
    }
  ],
  "links": [
    {
      "email": "Lazaro39@hotmail.com",
      "link": "https://sturdy-word.net"
    },
    {
      "email": "Bennett_Auer39@hotmail.com",
      "link": "https://delirious-gift.org"
    }
  ],
  "templateId": 64901629,
  "from": {
    "id": "esse dolore sit qui",
    "firstName": "Donna",
    "lastName": "Kozey",
    "email": "Mateo.Spinka6@hotmail.com"
  },
  "collaborators": [
    {
      "id": "sint",
      "firstName": "Eloisa",
      "lastName": "Bruen",
      "email": "Christopher_Kuhn@hotmail.com"
    },
    {
      "id": "officia",
      "firstName": "Ocie",
      "lastName": "Dickinson",
      "email": "Adrain.Prohaska75@hotmail.com"
    }
  ],
  "customMessage": "Quod vulgus ea sufficio comitatus templum sapiente atrocitas versus. Aeger communis degusto. Sequi sumo tardus.",
  "reminderInterval": 7,
  "dueDate": "2024-10-03T08:36:33.597Z",
  "deletionDate": "2024-10-03T13:26:09.061Z",
  "sendMethod": "EMAIL",
  "language": "es",
  "sendTogether": false,
  "unread": true,
  "createdAt": "2024-10-03T12:07:27.245Z",
  "updatedAt": "2024-10-02T15:14:01.332Z"
}

🟠400Bad Request

🟠404Record Not Found