How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

SignWell Bulk Send API

Send a document to multiple recipients in batch using templates.

SignWell Bulk Send API is one of 7 APIs that SignWell publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Bulk Send. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.

This API exposes 6 operations across 5 paths, and defines 29 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://www.signwell.com.

6 operations 5 paths 29 schemas 4 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://www.signwell.com/api/v1
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

SignWell Bulk Send API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Api-Key (api_key).

Paths & Operations 6

Across 5 paths, the API surfaces 6 operations — 4 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Bulk Send 6

Send a document to multiple recipients in batch using templates.

GET
/api/v1/bulk_sends/{id}
Get Bulk Send
getBulkSend 1 param → 200401404429
GET
/api/v1/bulk_sends
List Bulk Sendings
listBulkSends 4 params → 200401429
POST
/api/v1/bulk_sends
Create Bulk Send
createBulkSend body → 201422401429
GET
/api/v1/bulk_sends/csv_template
Get Bulk Send CSV Template
getBulkSendCsvTemplate 2 params → 200401404429
POST
/api/v1/bulk_sends/validate_csv
Validate Bulk Send CSV
validateBulkSendCsv body → 200422401429
GET
/api/v1/bulk_sends/{id}/documents
Get Bulk Send Documents
getBulkSendDocuments 3 params → 200401404429

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are DocumentResponse (37 properties), BulkSendDocumentsResponse (12 properties), BulkSendResponse (10 properties), CreateBulkSendRequest (10 properties). Each schema is shown below with its type and property counts.

Page
integer
The page number for pagination. Defaults to the first page.
FileInfo
object
File information
2 properties 2 required
BulkSendTemplateIds
array
Specify one or more templates to generate a single blank CSV file that will contain available columns for your recipient data. The templateids[] parameter is a…
CheckboxGroupInfo
object
Checkbox group configuration
9 properties 3 required
FieldType
string
Type of signing field
DocumentResponse
object
37 properties 2 required
CheckboxValidation
string
Validation rule for checkbox groups
BulkSendCsvTemplateResponse
object
Base64-encoded CSV template
1 property 1 required
BulkSendDocumentsResponse
object
Paginated list of documents in a bulk send
12 properties 5 required
UserEmail
string
The email address of the user that sent the Bulk Send. Must have the admin or manager role to view Bulk Sends of other users. Defaults to the user that the API…
CreateBulkSendRequest
object
10 properties 2 required
BulkSendId
string
Unique identifier for a bulk send.
AttachmentRequestInfo
object
Attachment request information
3 properties 2 required
BulkSendValidateCsvResponse
object
Validated bulk send CSV response with defaults applied
8 properties 2 required
BulkSendResponse
object
Bulk send details
10 properties 4 required
ValidationErrorResponse
object
Validation error response. The errors object contains field-specific error details with dynamic keys.
1 property 1 required
Base64Flag
boolean
When true, returns the CSV as a base64-encoded string in a JSON response instead of a binary file download.
RateLimitErrorResponse
object
Rate limit exceeded error response (HTTP 429)
1 property 1 required
ApiApplicationId
string
Unique identifier for API Application settings to use. API Applications are optional and mainly used when isolating OAuth apps or for more control over embedde…
TextValidation
string
Validation rule for text fields
Limit
integer
The number of documents to fetch. Defaults to 10, max is 50.
DateFormat
string
Date format for date fields. Valid values: MM/DD/YYYY, DD/MM/YYYY, YYYY/MM/DD, Month DD, YYYY, MM/DD/YYYY hh:mm:ss a. Default: MM/DD/YYYY
BulkSendCreateResponse
object
Bulk send creation response
7 properties 5 required
CopiedContactInfo
object
Copied contact information
3 properties 1 required
LabelInfo
object
Label information
2 properties
BulkSendCsvRequest
object
2 properties 2 required
BulkSendListResponse
object
List of bulk sends with pagination
6 properties 4 required
ErrorResponse
object
Standard error response
2 properties
BulkSendListItem
object
Bulk send summary in list responses
10 properties 8 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

signwell-bulk-send-api-openapi.yml Raw ↑

Other APIs SignWell publishes across the network.

SignWell API Application API
SignWell Document API
SignWell Me API
SignWell Regional API
SignWell Template API
SignWell Webhooks API
Where this information came from

This is an independent, third-party profile of SignWell Bulk Send API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.