Initialize File Sharing Session

Request

Body Params application/json

title

string

required

Title of the sharing session.

recipients

array[object (Recipient) {7}]

required

Users who files will be shared with.

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.

expirationDate

string <date-time>

optional

Timestamp when the file sharing session will expire and no longer be available for access and/or download.

deletionDate

string <date-time>

optional

Timestamp when all files will be automatically deleted from Pigeon.

customMessage

string

optional

Custom message to be displayed when recipients are viewing the file sharing session.

sendMethod

enum<string>

optional

How recipients will receive file sharing notifications. Defaults to e-mail.

Allowed values:

DEFAULTEMAILSMSBOTHMULTIPLE

language

enum<string>

optional

Defaults to English (en)

Allowed values:

en-USesarzhfrdehtheiditkoptparu

Example

{
  "title": "string",
  "recipients": [
    {
      "email": "string",
      "firstName": "string",
      "lastName": "string",
      "phone": "string",
      "authMethod": {
        "type": "EMAIL_ACCESS_CODE",
        "questionText": "string",
        "questionAnswer": "string"
      },
      "sendMethod": "DEFAULT",
      "completionOrder": 0
    }
  ],
  "expirationDate": "2019-08-24T14:15:22Z",
  "deletionDate": "2019-08-24T14:15:22Z",
  "customMessage": "string",
  "sendMethod": "DEFAULT",
  "language": "en-US"
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/shares' \
--header 'Content-Type: application/json' \
--data-raw '{
    "title": "string",
    "recipients": [
        {
            "email": "string",
            "firstName": "string",
            "lastName": "string",
            "phone": "string",
            "authMethod": {
                "type": "EMAIL_ACCESS_CODE",
                "questionText": "string",
                "questionAnswer": "string"
            },
            "sendMethod": "DEFAULT",
            "completionOrder": 0
        }
    ],
    "expirationDate": "2019-08-24T14:15:22Z",
    "deletionDate": "2019-08-24T14:15:22Z",
    "customMessage": "string",
    "sendMethod": "DEFAULT",
    "language": "en-US"
}'

Responses

🟢200Success

application/json

Body

id

string

required

ID

title

string

required

Title of the sharing session.

recipients

array[object (Recipient) {7}]

required

Users who files will be shared with.

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.

expirationDate

string <date-time>

optional

Timestamp when the file sharing session will expire and no longer be available for access and/or download.

deletionDate

string <date-time>

optional

Timestamp when all files will be automatically deleted from Pigeon.

customMessage

string

optional

Custom message to be displayed when recipients are viewing the file sharing session.

sendMethod

enum<string>

required

How recipients will receive file sharing notifications. Defaults to e-mail.

Allowed values:

DEFAULTEMAILSMSBOTHMULTIPLE

language

enum<string>

required

Allowed values:

en-USesarzhfrdehtheiditkoptparu

files

array[object (SharingFiles) {3}]

required

Files associated with file sharing session.

id

string

required

ID

name

string

required

File name

mime

string

required

File MIME type

Example

{
  "id": "90c5592b-0488-4457-bd86-58ec49e704b0",
  "title": "turpis via talis",
  "recipients": [
    {
      "email": "Coleman19@yahoo.com",
      "firstName": "Leda",
      "lastName": "Kiehn",
      "phoneNum": "(491) 974-7873",
      "authMethod": {
        "type": "EMAIL_ACCESS_CODE",
        "questionText": "minim quis",
        "questionAnswer": "eiusmod occaecat et fugiat"
      }
    },
    {
      "email": "Rosalyn.Frami74@gmail.com",
      "firstName": "Jakob",
      "lastName": "Mills",
      "phoneNum": "480.255.8475 x13464",
      "authMethod": {
        "type": "SECURITY_QUESTION",
        "questionText": "veniam in labore",
        "questionAnswer": "minim ut eu"
      }
    },
    {
      "email": "Aniyah.Boehm33@hotmail.com",
      "firstName": "Dixie",
      "lastName": "Predovic",
      "phoneNum": "362-224-3097",
      "authMethod": {
        "type": "SMS_ACCESS_CODE",
        "questionText": "aliqua do ex exercitation labore",
        "questionAnswer": "voluptate amet Lorem nisi"
      }
    }
  ],
  "expirationDate": "2024-10-03T10:04:18.792Z",
  "deletionDate": "2024-10-03T10:04:18.792Z",
  "customMessage": "Reprehenderit aspicio caste beneficium arca. Vomica aliquam sto adflicto vel varius decumbo sordeo neque adulatio. Aperio adsum tertius demulceo autem versus tutamen denuo.",
  "sendMethod": "EMAIL",
  "language": "en",
  "files": [
    {
      "id": "aute",
      "name": "amplexus aptus asporto",
      "mime": "application/pdf"
    }
  ]
}

🟠400Bad Request