Skip to content

Latest commit

 

History

History
155 lines (99 loc) · 4.54 KB

BulkSendJobApi.md

File metadata and controls

155 lines (99 loc) · 4.54 KB

dropbox_sign.BulkSendJobApi

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

Method HTTP request Description
bulk_send_job_get GET /bulk_send_job/{bulk_send_job_id} Get Bulk Send Job
bulk_send_job_list GET /bulk_send_job/list List Bulk Send Jobs

bulk_send_job_get

BulkSendJobGetResponse bulk_send_job_get(bulk_send_job_id)

Get Bulk Send Job

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

Example

  • Basic Authentication (api_key):
  • Bearer (JWT) Authentication (oauth2):
from pprint import pprint

from dropbox_sign import \
    ApiClient, ApiException, Configuration, apis

configuration = Configuration(
    # Configure HTTP basic authorization: api_key
    username="YOUR_API_KEY",

    # or, configure Bearer (JWT) authorization: oauth2
    # access_token="YOUR_ACCESS_TOKEN",
)

with ApiClient(configuration) as api_client:
    bulk_send_job_api = apis.BulkSendJobApi(api_client)

    bulk_send_job_id = "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174"

    try:
        response = bulk_send_job_api.bulk_send_job_get(bulk_send_job_id)
        pprint(response)
    except ApiException as e:
        print("Exception when calling Dropbox Sign API: %s\n" % e)

Parameters

Name Type Description Notes
bulk_send_job_id str The id of the BulkSendJob to retrieve.
page int Which page number of the BulkSendJob list to return. Defaults to 1. [optional][default to 1]
page_size int 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

HTTP response details

Status code Description Response headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -

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

bulk_send_job_list

BulkSendJobListResponse bulk_send_job_list()

List Bulk Send Jobs

Returns a list of BulkSendJob that you can access.

Example

  • Basic Authentication (api_key):
  • Bearer (JWT) Authentication (oauth2):
from pprint import pprint

from dropbox_sign import \
    ApiClient, ApiException, Configuration, apis

configuration = Configuration(
    # Configure HTTP basic authorization: api_key
    username="YOUR_API_KEY",

    # or, configure Bearer (JWT) authorization: oauth2
    # access_token="YOUR_ACCESS_TOKEN",
)

with ApiClient(configuration) as api_client:
    bulk_send_job_api = apis.BulkSendJobApi(api_client)

    page = 1
    page_size = 20

    try:
        response = bulk_send_job_api.bulk_send_job_list(
            page=page,
            page_size=page_size,
        )
        pprint(response)
    except ApiException as e:
        print("Exception when calling Dropbox Sign API: %s\n" % e)

Parameters

Name Type Description Notes
page int Which page number of the BulkSendJob List to return. Defaults to 1. [optional][default to 1]
page_size int 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

HTTP response details

Status code Description Response headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -

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