BulkSendApi
All URIs are relative to https://api.esignlaunchpad.com
| Method | HTTP request | Description |
|---|---|---|
| bulkSendFromTemplate | POST /api/v1/templates//bulk-send | |
| getBulkSendJob | GET /api/v1/bulk-send-jobs/ | |
| listBulkSendJobs | GET /api/v1/bulk-send-jobs | |
| retryBulkSendFailed | POST /api/v1/bulk-send-jobs//retry-failed |
bulkSendFromTemplate
BulkSendQueuedResponse bulkSendFromTemplate(templateGuid, BulkSendApiRequest)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| templateGuid | UUID | [default to null] | |
| BulkSendApiRequest | BulkSendApiRequest |
Return type
Authorization
HTTP request headers
- Content-Type: application/json, text/json, application/*+json
- Accept: application/json
getBulkSendJob
BulkSendJobStatusResponse getBulkSendJob(jobGuid)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| jobGuid | UUID | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
listBulkSendJobs
BulkSendJobListResponse listBulkSendJobs(page, pageSize, status)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| page | Integer | [optional] [default to null] | |
| pageSize | Integer | [optional] [default to null] | |
| status | String | [optional] [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
retryBulkSendFailed
BulkSendRetryFailedResponse retryBulkSendFailed(jobGuid, BulkSendRetryFailedRequest)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| jobGuid | UUID | [default to null] | |
| BulkSendRetryFailedRequest | BulkSendRetryFailedRequest | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: application/json, text/json, application/*+json
- Accept: application/json