Skip to main content

Bulk invite users via Excel upload

POST 
/v1/spaces/:spaceId/users/invitations:bulkImport

Preview: The API is in development or testing phases and the interface could still change slightly.

Uploads an Excel (.xlsx) file containing multiple user invitations and starts an invitation process for each valid row.

The file must match the template available at GET /v1/spaces/{spaceId}/users/invitations:bulkImport/template. Each row represents one invitee with a yes/no selection per role column.

Role columns (in order): space_admin, purchases_full, purchases_limited, sales_full, sales_limited, financial_full, accountant.

Role normalisation rules:

  • If purchases_full is yes, purchases_limited is ignored even if also yes.
  • If sales_full is yes, sales_limited is ignored even if also yes.

The response is a JSON summary with the total number of rows processed and a breakdown of successes and failures. A 200 does not guarantee all rows succeeded — check numberOfFailures to determine if any rows were rejected.

Constraints:

  • Maximum file size: 5 MB
  • Maximum data rows: 100
  • Accepted file type: .xlsx only

Authentication: Requires a valid Bearer token. Inviter details (name, email) are resolved automatically from the JWT — they do not need to be provided in the file.
Scope: []

Request​

Responses​

Bulk import processed. Returns a JSON summary of the import results. A 200 does not guarantee all rows succeeded — check numberOfFailures for rows that were rejected due to validation errors or process start failures.