For the complete documentation index, see llms.txt. This page is also available as Markdown.

Mass create users

This document contains details for the POST /api/v1/account/{accountUuid}/users endpoint, including the required headers, XLSX upload format, and target account parameter.

Use this endpoint to upload the completed XLSX template and create users in bulk. Use the same file structure as the template from Download Example File.

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

How it works

  1. Download the example XLSX file.

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

  3. Upload the completed file to create users in bulk.

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

Last updated

Was this helpful?