Skip to content

BulkSendJobApi.md

Latest commit

 

History

History
125 lines (86 loc) · 3.54 KB

BulkSendJobApi.md

File metadata and controls

125 lines (86 loc) · 3.54 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 fs from 'fs';
import api from "@dropbox/sign"
import models from "@dropbox/sign"

const apiCaller = new api.BulkSendJobApi();
apiCaller.username = "YOUR_API_KEY";
// apiCaller.accessToken = "YOUR_ACCESS_TOKEN";

apiCaller.bulkSendJobGet(
  "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174", // bulkSendJobId
  1, // page
  20, // pageSize
).then(response => {
  console.log(response.body);
}).catch(error => {
  console.log("Exception when calling BulkSendJobApi#bulkSendJobGet:");
  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 fs from 'fs';
import api from "@dropbox/sign"
import models from "@dropbox/sign"

const apiCaller = new api.BulkSendJobApi();
apiCaller.username = "YOUR_API_KEY";
// apiCaller.accessToken = "YOUR_ACCESS_TOKEN";

apiCaller.bulkSendJobList(
  1, // page
  20, // pageSize
).then(response => {
  console.log(response.body);
}).catch(error => {
  console.log("Exception when calling BulkSendJobApi#bulkSendJobList:");
  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]