Pigeon // E-Sign
  1. Bulk Send
Pigeon // E-Sign
  • Introduction
  • Authentication
  • Integrations
  • Documents
    • List Documents
      GET
    • Create Document
      POST
    • Get Document Status
      GET
    • Delete Document
      DELETE
    • Update Document
      PATCH
    • Update Document Status
      PATCH
    • Move Document to Draft
      POST
    • Get Document Details
      GET
    • Send Document
      POST
    • Create Document Session
      POST
    • Download Document
      GET
    • Download Protected Document
      GET
    • Update Document Ownership
      PATCH
    • Transfer Documents Ownership
      PATCH
  • Document Attachments
    • Document Attachment List
      GET
    • Document Attachment Create
      POST
    • Document Attachment Details
      GET
    • Document Attachment Delete
      DELETE
    • Document Attachment Download
      GET
  • Document Generation
    • List Document Fields
    • Create Document Fields
  • Document Recipients
    • Add Document Recipient
    • Edit Document Recipient
    • Delete Document Recipient
    • Reassign Document Recipient
  • Bulk Send
    • Trigger Bulk Send
      POST
    • Create Bulk Send List
      POST
    • Get Bulk Send List
      GET
    • Get Bulk Send Lists
      GET
    • Update Bulk Send List
      PATCH
    • Delete Bulk Send List
      DELETE
  • Templates
    • List Templates
    • Create Template
    • Template Details
    • Delete Template
  • Cloud Storage
    • List Cloud Storage Providers
    • Connect Cloud Storage Providers
    • Disconnect Cloud Storage Provider
  • Webhooks
    • Get all webhook subscriptions
    • Create webhook subscription
    • Get webhook subscription by uuid
    • Update webhook subscription
    • Delete webhook subscription
  • Branding
    • Get Organization Branding
    • Update Organization Branding
  • Confirmation Page
    • Enable/Disable Signature Confirmation Page
  1. Bulk Send

Create Bulk Send List

POST
/bulksends/lists
Create a new bulk send list.

Request

Body Params application/json

Example
{
    "id": "minim Duis labore magna",
    "name": "subiungo abundans decerno",
    "items": [
        {
            "email": "Darian91@gmail.com",
            "customFields": [
                {
                    "name": "magnam in caute",
                    "value": 79721155
                }
            ]
        },
        {
            "email": "Liliane64@hotmail.com",
            "customFields": [
                {
                    "name": "suggero suscipit vacuus",
                    "value": "ipsum cupidatat nostrud"
                },
                {
                    "name": "sodalitas textilis adiuvo",
                    "value": null
                }
            ]
        }
    ]
}

Request Code 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 '/bulksends/lists' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": "minim Duis labore magna",
    "name": "subiungo abundans decerno",
    "items": [
        {
            "email": "Darian91@gmail.com",
            "customFields": [
                {
                    "name": "magnam in caute",
                    "value": 79721155
                }
            ]
        },
        {
            "email": "Liliane64@hotmail.com",
            "customFields": [
                {
                    "name": "suggero suscipit vacuus",
                    "value": "ipsum cupidatat nostrud"
                },
                {
                    "name": "sodalitas textilis adiuvo",
                    "value": null
                }
            ]
        }
    ]
}'

Responses

🟢200Success
application/json
Body

Example
{
    "id": "in Duis culpa nulla Ut",
    "name": "crepusculum tamen aduro",
    "items": [
        {
            "email": "Verner_Schmidt93@hotmail.com",
            "customFields": [
                {
                    "name": "collum suspendo cupiditate",
                    "value": -16534451.468607888
                },
                {
                    "name": "victus speculum suscipio",
                    "value": -69681586
                }
            ]
        }
    ]
}
🟠400Bad Request
Modified at 2024-09-17 18:04:28
Previous
Trigger Bulk Send
Next
Get Bulk Send List