Create Request

POST

/requests

Create a new document collection request and send out the request to the specified recipients.

Request

Body Params application/json

Example

{
    "recipients": [
        {
            "first_name": "string",
            "last_name": "string",
            "email": "user@example.com",
            "phone": "string",
            "language": "en-US",
            "id": "string",
            "auth_method": "NONE",
            "send_method": "EMAIL",
            "question_text": "string",
            "question_answer": "string"
        }
    ],
    "name": "string",
    "due_date": "2019-08-24T14:15:22Z",
    "expiration_date": "2019-08-24T14:15:22Z",
    "personal_message": "string",
    "notes": "string",
    "user_metadata": {},
    "language": "en-US",
    "reminders": 3,
    "items": [],
    "collaborators": [],
    "cloud_storage_folder": "string",
    "cloud_storage_provider": "PIGEON",
    "owner_id": "string",
    "mfa_enabled": true,
    "template_id": "string",
    "skip_initial_notification": false,
    "overwrite_template_items": false
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/requests' \
--header 'Content-Type: application/json' \
--data-raw '{
    "recipients": [
        {
            "first_name": "string",
            "last_name": "string",
            "email": "user@example.com",
            "phone": "string",
            "language": "en-US",
            "id": "string",
            "auth_method": "NONE",
            "send_method": "EMAIL",
            "question_text": "string",
            "question_answer": "string"
        }
    ],
    "name": "string",
    "due_date": "2019-08-24T14:15:22Z",
    "expiration_date": "2019-08-24T14:15:22Z",
    "personal_message": "string",
    "notes": "string",
    "user_metadata": {},
    "language": "en-US",
    "reminders": 3,
    "items": [],
    "collaborators": [],
    "cloud_storage_folder": "string",
    "cloud_storage_provider": "PIGEON",
    "owner_id": "string",
    "mfa_enabled": true,
    "template_id": "string",
    "skip_initial_notification": false,
    "overwrite_template_items": false
}'

Responses

🟢200OK

application/json

Successful Response

Body

Example

{
    "name": "string",
    "items": [
        {
            "name": "string",
            "id": "string",
            "type": "UPLOAD",
            "description": "string",
            "required": true,
            "answer": "string",
            "verified": false
        }
    ],
    "recipients": [
        {
            "request_link": "string",
            "mfa_link": "string",
            "auth": "NONE",
            "password": "string",
            "recipient": {
                "id": "string",
                "first_name": "string",
                "last_name": "string",
                "email": "string",
                "phone": "string",
                "owner_id": "string",
                "language": "en-US"
            }
        }
    ],
    "id": "string",
    "owner_id": "string",
    "owner_opened": true,
    "user_opened": true,
    "status": "CLOSED",
    "verified": true,
    "deleted": true,
    "rejected": true,
    "due_date": "2019-08-24T14:15:22Z",
    "expiration_date": "2019-08-24T14:15:22Z",
    "personal_message": "string",
    "notes": "string",
    "user_metadata": {},
    "language": "en-US",
    "reminders": "-1",
    "collaborators": [],
    "cloud_storage_folder": "string",
    "cloud_storage_provider": "PIGEON",
    "template_id": "string",
    "percent_complete": 0
}

🟠404Record Not Found

🟠422Parameter Error

Requests

List Requests