BulkSend: getBulkSendLists

This method returns a list of bulk send lists belonging to the current user, as well as basic information about each list.

Request

HTTP request

GET /v2.1/accounts/{accountId}/bulk_send_lists

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

The external account number (int) or account ID GUID.

Responses

CodeDescriptionReference
200

Successful response.

bulkSendingListSummaries
400

Error encountered.

errorDetails

SDK Method

BulkEnvelopes::getBulkSendLists

Definitions

bulkSendingListSummaries

This complex type contains summaries that provide basic information about the bulk send lists that belong to the current user.

bulkListSummaries[bulkSendingListSummary]

An array of bulkSendingListSummary objects where each summary provides basic information about a bulk send list that belongs to the current user.

bulkSendingListSummary

This object contains basic information about a bulk send list.

bulkSendListIdstring

The GUID of the bulk send list. This property is created after you post a new bulk send list.

createdByUserstring

The GUID of the user who created the bulk send list.

createdDatestring

The UTC DateTime that the bulk send list was created.

namestring

The name of the bulk send list.

errorDetails

This object describes errors that occur. It is only valid for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

}} />