This API prepares a ZIP archive containing all the files associated with a conversation id.

Request

Method URL
POST https://{domain}/v1/account/{accountId}/bulk-download-requests

Request Headers

Header Description
Authorization Contains token string to allow request authentication and authorization: "Bearer {token}".
Content-Type application/json

Path Parameters

Parameter Description Type / Value
accountId LP site ID String

Request Body

Attribute Description Type
Filter Contains a json list of filters that the downloaded files should satisfy. Currently only conversationId is allowed in the filter. JSON

Request body Example

{ 
  "filter" : { 
    "conversationId": "8f28be9b-6960-47d0-93e0-ddbc5bde1d5c" 
  } 
}

Response

Response Codes

Code Description
201 Created
400 Bad Request
401 Unauthorized
403 Forbidden
429 Too Many Requests
500 Internal Server Error

Response Body

Entity Structure

Attribute Description Type / Value
requestId ID of the bulk file download request String
accountId Account id of the client String
status Status of the zip archieve request. It should be NEW String
filter Filter provided in the request body String
downloadUrls Array of links to the zipped archive. Currently capped at 500 MB per archive or 50 files String
createdAt timestamp of when the zipped archive was created String

Entity Example

{
 "requestId": "76414f59-1b9c-4ce8-bf8b-8e0b76c9889f",
 "accountId": "54645235",
 "status": "NEW",
 "filter" : {
  "conversationId": "8f28be9b-6960-47d0-93e0-ddbc5bde1d5c"
 },
 "downloadUrls": [],
 "createdAt": "2024-01-15T18:20:22.775+00:00"
}