Skip to main content
POST
Create users in workspace

Authorizations

Authorization
string
header
required

JWT bearer authentication. The token payload must include partner_id, nbf (not-before) and exp (expiry) claims. All Partner API requests must be authenticated with Authorization: Bearer .

Headers

X-TL-Partner-Id
string
required

The unique identifier for the partner.

Path Parameters

workspace_id
string
required

The unique identifier for the workspace.

Body

application/json

User creation request payload

Request payload for bulk-creating placeholder agent users in a workspace. The count field specifies how many users to provision in a single all-or-nothing operation, subject to available seats in the workspace.

count
integer
required

Number of users to create

Required range: 1 <= x <= 99
Example:

3

Response

Users created

Response payload for bulk user creation. Contains the workspace_id, updated seat counters (seats_total and seats_available), and the list of created users with their identifiers and metadata. This response is typically consumed to track which agents were provisioned for QR-link generation.

workspace_id
string
required

Unique identifier for the workspace

Example:

"my-first-workspace"

seats_total
integer
required

Total number of seats in the workspace

Example:

3

seats_available
integer
required

Number of available seats in the workspace

Example:

2

users
object[]
required