Exportaciones
Cada operación de este grupo: lo que acepta, lo que devuelve y los errores con los que puede responder.
Operaciones
A zip of the whole workspace, as the Export page of the app makes it: every conversation as mbox files with its attachments, contacts as vCard, audiences, calendar events as .ics, templates with every version, rules, labels, notes and addresses. An export is made in the background, can be started once a day and is kept for 365 days.
Only the workspace owner, or a member whose role holds every permission, can export the workspace: an API key, or an app connected with every address. A key or an app limited to particular addresses or domains is a 422 capability_unsupported, and an account the workspace cannot export for is a 403 export_not_permitted.
GET/exports/preview
See what an export would hold
Whether this workspace can be exported by the caller now, when the next export can start, the export still being made, if there is one, and how much an export would hold. When allowed is false, reason says why and counts is null.
Only the workspace owner, or a member whose role holds every permission, can export the workspace: an API key, or an app connected with every address. A key or an app limited to particular addresses or domains is a 422 capability_unsupported, and an account the workspace cannot export for is a 403 export_not_permitted.
Requires the threads:read scope.
Devuelve
What an export would hold, and whether one can start.
Errores
Los errores que puede devolver cualquier operación400401403404422500Catálogo de errores
También disponible en
GET/exports
List the exports
Every export of the workspace, newest first, with its status and progress. limit and offset page through them, and total counts them all.
Only the workspace owner, or a member whose role holds every permission, can export the workspace: an API key, or an app connected with every address. A key or an app limited to particular addresses or domains is a 422 capability_unsupported, and an account the workspace cannot export for is a 403 export_not_permitted.
Requires the threads:read scope.
Parámetros de consulta
limitintegerExports per page, 1 to 100.
Al menos 1Como máximo 100Predeterminado25offsetintegerHow many exports to skip.
Al menos 0Predeterminado0
Devuelve
A page of exports, newest first.
Errores
Los errores que puede devolver cualquier operación400401403404422500Catálogo de errores
También disponible en
POST/exports
Start an export
Starts making a zip of the whole workspace, as Export now on the Export page does. It is made in the background: read it with GET /exports/{id} until status is ready, then download it. One export can run at a time, and a workspace can be exported once a day.
Only the workspace owner, or a member whose role holds every permission, can export the workspace: an API key, or an app connected with every address. A key or an app limited to particular addresses or domains is a 422 capability_unsupported, and an account the workspace cannot export for is a 403 export_not_permitted.
Requires the threads:read scope.
Devuelve
The export, queued.
Errores
- 403
The key lacks the scope, or may not send as that address.
step_up_required: the call was made with an OAuth access token that has not been verified in the last 60 minutes. Ask for a code withPOST /security/step-up, send it toPOST /security/step-up/verify, then repeat the call. The person can also choose Allow changes for 60 minutes on the app in Account settings, Connected apps, on the OpenEmail website. An API key is never asked for a code.- 409
already_running: an export of this workspace is already being made.- 429
export_limit_reached: the workspace was exported in the last day.
Los errores que puede devolver cualquier operación400401404422500Catálogo de errores
También disponible en
GET/exports/{id}
Retrieve an export
One export, with its status, its progress through the conversations and, once it is ready, its size, file name and when it is deleted.
Only the workspace owner, or a member whose role holds every permission, can export the workspace: an API key, or an app connected with every address. A key or an app limited to particular addresses or domains is a 422 capability_unsupported, and an account the workspace cannot export for is a 403 export_not_permitted.
Requires the threads:read scope.
Parámetros de ruta
idstringObligatorioThe export id from
GET /exportsorPOST /exports.
Devuelve
The export.
Errores
Los errores que puede devolver cualquier operación400401403404422500Catálogo de errores
También disponible en
GET/exports/{id}/content
Download an export
The zip itself, as application/zip with its file name in Content-Disposition. It is only there once the export is ready: before that the call is a 409 export_not_ready, and an export older than 365 days is a 409 expired.
Only the workspace owner, or a member whose role holds every permission, can export the workspace: an API key, or an app connected with every address. A key or an app limited to particular addresses or domains is a 422 capability_unsupported, and an account the workspace cannot export for is a 403 export_not_permitted.
Requires the threads:read scope.
Parámetros de ruta
idstringObligatorioThe export id from
GET /exportsorPOST /exports.
Devuelve
application/zipThe zip.
Errores
- 403
The key lacks the scope, or may not send as that address.
step_up_required: the call was made with an OAuth access token that has not been verified in the last 60 minutes. Ask for a code withPOST /security/step-up, send it toPOST /security/step-up/verify, then repeat the call. The person can also choose Allow changes for 60 minutes on the app in Account settings, Connected apps, on the OpenEmail website. An API key is never asked for a code.- 409
export_not_ready: the export is still being made or failed.expired: it was deleted a year after it was made.
Los errores que puede devolver cualquier operación400401404422500Catálogo de errores
También disponible en
Objetos
Exportobject
objectstringObligatorio- Uno de
"export" idstringObligatoriostatusstringObligatorio- Uno de
"queued""running""ready""failed""expired" phasestringWhat it is doing while
statusisrunning.Puede ser nullUno de"planning""mail""records""finishing"createdAtstringObligatorio- Formato
date-time createdByobjectWho started it, or null when that account is gone.
Puede ser nullnamestring- Puede ser null
emailstring
startedAtstring- Puede ser nullFormato
date-time finishedAtstring- Puede ser nullFormato
date-time expiresAtstringWhen the zip is deleted, a year after it was made.
Puede ser nullFormatodate-timesizeBytesinteger- Puede ser null
fileNamestring- Puede ser null
threadsDoneinteger- Al menos 0
threadsTotalinteger- Puede ser null
errorstringWhy it failed, when
statusisfailed.Puede ser null
ExportListobject
objectstring- Uno de
"list" dataExport[]totalintegerHow many exports there are in all.
Al menos 0hasMorebooleanWhether more exports follow this page.
ExportPreviewobject
objectstringObligatorio- Uno de
"export_preview" allowedbooleanObligatorioWhether the caller may export this workspace.
reasonstringObligatorioWhy not, when
allowedis false:not-permittedfor an account that is neither the owner nor holds every permission,mailbox-loginfor a sign-in for one address, andtwo-factor-requiredwhen the workspace requires two-factor sign-in and the account has none.Puede ser nullUno de"not-permitted""mailbox-login""two-factor-required"nextAvailableAtstringObligatorioWhen the next export can start, or null when one can start now.
Puede ser nullFormatodate-timeactiveExportIdstringObligatorioThe export still being made, if there is one.
Puede ser nullcountsobjectObligatorioHow much an export would hold now. Null when
allowedis false.Puede ser nullthreadsintegerConversations.
Al menos 0attachmentsintegerAttachments inside them.
Al menos 0attachmentBytesintegerThe size of those attachments, in bytes.
Al menos 0deletedFilesintegerDeleted files, listed by name and date but not included.
Al menos 0contactsintegerContacts.
Al menos 0audiencesintegerAudiences.
Al menos 0calendarEventsintegerCalendar events.
Al menos 0templatesintegerTemplates.
Al menos 0rulesintegerRules.
Al menos 0labelsintegerLabels.
Al menos 0notesintegerNotes of the caller.
Al menos 0addressesintegerAddresses.
Al menos 0