Export Room

Export room to a file or email.

This requires the user to have the mail-messages permission.

HTTP Method	URL	Requires Auth
POST	/api/v1/rooms.export	yes

Body Parameters

Key	Example Value	Description
rid*	JZ8Y2dLfYhsg323Rf	The room ID.
type*	email or file	How you want the room to be exported.
dateFrom	2020-01-13	Start date to begin fetching.
dateTo	2021-12-13	End date for fetching.
format*	html or json	The file type to export as.

Example Call

curl -L -X POST 'http://localhost:3000/api/v1/rooms.export' \
-H 'X-User-Id: d26x6zSkaPSe5gCyy' \
-H 'X-Auth-Token: Zu-Z6eKzIIz7MCCRGeHi29bYkXZCJ4SxFC0JAasqm92' \
-H 'Content-Type: application/json' \
--data-raw '{
    "rid": "iu7jtPAhvEeAS5tNq",
    "type": "file",
    "dateFrom": "2000-01-01",
    "dateTo": "2021-11-25",
    "format": "html"
}'

Example Response

Success

{
    "success": true
}

Error

Any of the following errors can occur:

• Authorization: Requires an authentication token for the request to be made.

• Invalid Params: Occurs when one or more needed parameters are missing.

• Invalid Room: Occurs when the given rid is invalid.

• Not Allowed: Occurs when the user lacks the mail-messages permission and doesn't have access to the room.

• Invalid Format: Occurs when the export format is not specified

Authorization

{
    "success": false,
    "error": "unauthorized"
}

Invalid Params

{
    "success": false,
    "error": "[error-invalid-params]",
    "errorType": "error-invalid-params"
}

Invalid Room ID

{
    "success": false,
    "error": "[error-invalid-room]",
    "errorType": "error-invalid-room"
}

Invalid Format

{
    "success": false,
    "error": "[error-invalid-format]",
    "errorType": "error-invalid-format"
}

Version	Description
3.8.0	Added