Account Corporate Users

This document contains the corporate users API endpoints for an account, including downloading an example XLSX file and mass creating users.

Use these endpoints to prepare and upload a corporate users import file for one account. Download the example XLSX file first, fill it with user data, and then upload the completed file.

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 XLSX file to create users in bulk.

Download example file

Use this endpoint to download the XLSX template for bulk user creation. The file contains the available roles, permissions, and mailboxes for the target account.

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

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.

Response status codes

Code	Description
200	Success
401	Not authorized
403	Forbidden

Mass create users

Use this endpoint to upload the completed XLSX file and create users in bulk. Upload the file in the same structure as the downloaded example template.

Endpoint
Method	POST
Request URL	/api/v1/account/{accountUuid}/users
Headers
Authorization *	Bearer TOKEN
Content-Type *	multipart/form-data
Request
accountUuid *	Target account UUID
Body *	XLSX binary

Request example

POST https://api.platform_address_here/api/v1/account/3fa85f64-5717-4562-b3fc-2c963f66afa6/users
Authorization: Bearer {token}
Content-Type: multipart/form-data

file=@corporate-users.xlsx

Response

The endpoint returns 200 if the import request succeeds.

Response status codes

Code	Description
200	Success
401	Not authorized
403	Forbidden

Related topics

• Download Example File

• Mass create users

• Account Domains