Skip to main content
POST
/
v1
/
exports
Create data export
curl --request POST \
  --url https://api.zavu.dev/v1/exports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dataTypes": [
    "messages",
    "conversations"
  ],
  "dateFrom": "2024-01-01T00:00:00Z",
  "dateTo": "2024-12-31T23:59:59Z"
}
'
{
  "export": {
    "id": "exp_abc123",
    "status": "pending",
    "dataTypes": [
      "messages"
    ],
    "expiresAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "dateFrom": "2023-11-07T05:31:56Z",
    "dateTo": "2023-11-07T05:31:56Z",
    "downloadUrl": "<string>",
    "fileSize": 123,
    "errorMessage": "<string>",
    "completedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
dataTypes
enum<string>[]
required

List of data types to include in the export.

Minimum array length: 1

Types of data that can be exported.

Available options:
messages,
conversations,
webhookDeliveries,
agentExecutions,
activities
​
dateFrom
string<date-time>

Start date for data to export (inclusive).

​
dateTo
string<date-time>

End date for data to export (inclusive).

Response

Export job created.

​
export
object
required