Close Request

Marks a request as closed.

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": "769454c3-2483-4278-87d6-b7dbdfc107ae",
    "title": "Sample Request",
    "status": "CLOSED",
    "items": [
        {
            "type": "QUESTION",
            "name": "tabernus tamquam cupressus",
            "description": "Ceno thermae uredo pecus crastinus coniuratio cubo surculus coniecto laudantium. Cariosus cupio certus atrocitas appello arca victus deleniti. Veritas attonbitus subnecto voluptates ipsa non contego aduro copiose cultura.",
            "required": true,
            "question": {
                "id": "Lorem",
                "questionText": "est aliquip occaecat",
                "questionAnswer": "ea ipsum sint labore reprehenderit"
            }
        },
        {
            "type": "STANDARD",
            "name": "exercitationem deleniti asperiores",
            "description": "Absorbeo tendo adhaero aqua. Vobis cuius vix cunabula acidus tepidus accusator. Bellum damno caelestis patrocinor officiis deinde suppono curtus.",
            "required": true,
        }
    ],
    "recipients": [
        {
            "email": "Monroe.Goodwin36@yahoo.com",
            "firstName": "Kaia",
            "lastName": "Kunze",
            "phoneNum": "984-681-0230 x64236",
            "authMethod": {
                "type": "SMS_ACCESS_CODE",
                "questionText": "in",
                "questionAnswer": "magna culpa enim"
            }
        },
        {
            "email": "Elva73@hotmail.com",
            "firstName": "Jacinto",
            "lastName": "Reichel",
            "phoneNum": "1-917-602-6097 x1122",
            "authMethod": {
                "type": "EMAIL_ACCESS_CODE"
            }
        },
        {
            "email": "Oscar99@gmail.com",
            "firstName": "Sonya",
            "lastName": "Greenholt",
            "phoneNum": "525.991.0317",
            "authMethod": {
                "type": "SMS_ACCESS_CODE"
            }
        }
    ],
    "links": [
        {
            "email": "Yasmine37@yahoo.com",
            "link": "https://quarterly-obedience.name"
        }
    ],
    "templateId": 19073458,
    "from": {
        "id": "enim anim",
        "firstName": "Reyes",
        "lastName": "Reilly",
        "email": "Lessie.Harris@gmail.com"
    },
    "collaborators": [
        {
            "id": "ut",
            "firstName": "Eleanora",
            "lastName": "Lowe",
            "email": "Merritt_Aufderhar11@hotmail.com"
        }
    ],
    "customMessage": "Cedo atrocitas adipiscor quaerat conventus impedit deserunt confugo patrocinor amissio. Paulatim condico alii qui sed villa contabesco aedificium. Maxime aedificium vicinus.",
    "reminderInterval": 7,
    "dueDate": "2024-10-01T18:09:58.511Z",
    "deletionDate": "2024-10-02T13:07:20.757Z",
    "sendMethod": "SMS",
    "language": "en",
    "sendTogether": true,
    "createdAt": "2024-10-02T04:27:59.959Z",
    "updatedAt": "2024-10-01T22:34:22.740Z"
}

🟠404Record Not Found

Request

Request samples

Responses