Download Example File

This document contains details for the GET /api/v1/account/{accountUuid}/users/example endpoint, including the request URL, headers, and returned XLSX example file.

Use this endpoint to download the XLSX template for bulk user creation. Use the downloaded file as the source template for Mass create users.

Endpoint
Method	GET
Request URL	/api/v1/account/{accountUuid}/users/example
Headers
Authorization *	Bearer TOKEN
Request
accountUuid *	Target account UUID

How it works

1. Download the example XLSX file for the target account.

2. Fill the file with user data, roles, permissions, and mailbox assignments.

3. Upload the completed file with Mass create users.

Request example

GET https://api.platform_address_here/api/v1/account/3fa85f64-5717-4562-b3fc-2c963f66afa6/users/example
Authorization: Bearer {token}

Response

The response body contains an .xlsx file. The endpoint does not return JSON.

Response status codes

Code	Description
200	Success
401	Not authorized
403	Forbidden

Related topics

• Account Corporate Users

• Mass create users