Skip to content

Latest commit

 

History

History
180 lines (119 loc) · 4.94 KB

BulkSendJobApi.md

File metadata and controls

180 lines (119 loc) · 4.94 KB

BulkSendJobApi

All URIs are relative to https://api.hellosign.com/v3.

Method HTTP request Description
bulkSendJobGet() GET /bulk_send_job/{bulk_send_job_id} Get Bulk Send Job
bulkSendJobList() GET /bulk_send_job/list List Bulk Send Jobs

bulkSendJobGet()

bulkSendJobGet(bulkSendJobId: string, page: number, pageSize: number): BulkSendJobGetResponse

Get Bulk Send Job

Returns the status of the BulkSendJob and its SignatureRequests specified by the bulk_send_job_id parameter.

TypeScript Example

import * as DropboxSign from "@dropbox/sign";

const bulkSendJobApi = new DropboxSign.BulkSendJobApi();

// Configure HTTP basic authorization: api_key
bulkSendJobApi.username = "YOUR_API_KEY";

// or, configure Bearer (JWT) authorization: oauth2
// bulkSendJobApi.accessToken = "YOUR_ACCESS_TOKEN";

const bulkSendJobId = "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174";

const result = bulkSendJobApi.bulkSendJobGet(bulkSendJobId);
result.then(response => {
  console.log(response.body);
}).catch(error => {
  console.log("Exception when calling Dropbox Sign API:");
  console.log(error.body);
});

JavaScript Example

import * as DropboxSign from "@dropbox/sign";

const bulkSendJobApi = new DropboxSign.BulkSendJobApi();

// Configure HTTP basic authorization: api_key
bulkSendJobApi.username = "YOUR_API_KEY";

// or, configure Bearer (JWT) authorization: oauth2
// bulkSendJobApi.accessToken = "YOUR_ACCESS_TOKEN";

const bulkSendJobId = "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174";

const result = bulkSendJobApi.bulkSendJobGet(bulkSendJobId);
result.then(response => {
  console.log(response.body);
}).catch(error => {
  console.log("Exception when calling Dropbox Sign API:");
  console.log(error.body);
});

Parameters

Name Type Description Notes
bulkSendJobId string The id of the BulkSendJob to retrieve.
page number Which page number of the BulkSendJob list to return. Defaults to 1. [optional] [default to 1]
pageSize number Number of objects to be returned per page. Must be between 1 and 100. Default is 20. [optional] [default to 20]

Return type

BulkSendJobGetResponse

Authorization

api_key, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

bulkSendJobList()

bulkSendJobList(page: number, pageSize: number): BulkSendJobListResponse

List Bulk Send Jobs

Returns a list of BulkSendJob that you can access.

TypeScript Example

import * as DropboxSign from "@dropbox/sign";

const bulkSendJobApi = new DropboxSign.BulkSendJobApi();

// Configure HTTP basic authorization: api_key
bulkSendJobApi.username = "YOUR_API_KEY";

// or, configure Bearer (JWT) authorization: oauth2
// bulkSendJobApi.accessToken = "YOUR_ACCESS_TOKEN";

const page = 1;
const pageSize = 20;

const result = bulkSendJobApi.bulkSendJobList(page, pageSize);
result.then(response => {
  console.log(response.body);
}).catch(error => {
  console.log("Exception when calling Dropbox Sign API:");
  console.log(error.body);
});

JavaScript Example

import * as DropboxSign from "@dropbox/sign";

const bulkSendJobApi = new DropboxSign.BulkSendJobApi();

// Configure HTTP basic authorization: api_key
bulkSendJobApi.username = "YOUR_API_KEY";

// or, configure Bearer (JWT) authorization: oauth2
// bulkSendJobApi.accessToken = "YOUR_ACCESS_TOKEN";

const page = 1;
const pageSize = 20;

const result = bulkSendJobApi.bulkSendJobList(page, pageSize);
result.then(response => {
  console.log(response.body);
}).catch(error => {
  console.log("Exception when calling Dropbox Sign API:");
  console.log(error.body);
});

Parameters

Name Type Description Notes
page number Which page number of the BulkSendJob List to return. Defaults to 1. [optional] [default to 1]
pageSize number Number of objects to be returned per page. Must be between 1 and 100. Default is 20. [optional] [default to 20]

Return type

BulkSendJobListResponse

Authorization

api_key, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]