Exports
A zip of the whole workspace.
Exports tools
| Tool | What it does |
|---|---|
| getExportPreview | Whether an export can start now, when the next one can, the export still being made and how much an export would hold. |
| listExports | The exports of the workspace, newest first, with their status, progress and size. |
| getExport | One export by its id. |
| startExport | Start making a zip of the whole workspace, once a day. It asks for a verification code, and in the app’s chat it always asks first. |
Only the workspace owner, or a member whose role holds every permission, can export, through a client connected with every address. Every tool needs threads:read.
No tool returns the zip. Download it on the Export page of the app, with GET /exports/{id}/content on the REST API, exports.download in the SDK or openemail exports download on the command line.
Some tools on this server make a change the REST API guards with a verification code, and ask for the same code. Until the client has verified a code in the last 60 minutes, or the person has chosen Allow changes for 60 minutes on it in Account → Connected apps, such a tool answers with a result that starts Refused (step_up_required): and changes nothing. emptyAudience never asks for a code. The API Authentication page lists every tool that asks, and shows how to ask for a code and verify it.
Reference
getExportPreview
Whether this workspace can be exported now, when the next export can start, the export still being made, and how much an export would hold: conversations, attachments, contacts, audiences, calendar events, templates, rules, labels, notes and addresses.
Inputs
Takes no input.
Also available in
listExports
The exports of this workspace, newest first, with their status, progress, size and when each is deleted. A ready one is downloaded on the Export page of the app or with GET /exports/{id}/content on the REST API.
Inputs
limitinteger- At least 1At most 100
offsetinteger- At least 0
Also available in
getExport
One export by its id: its status, its progress through the conversations, its size and when it is deleted.
Inputs
idstringRequired- 1 to 128 characters
Also available in
startExport
Start making a zip of the whole workspace, as Export now on the Export page does. It is made in the background, one at a time and once a day, and kept for a year. Ask the person first.
- Asks for a verification code
POST /exports
Inputs
Takes no input.