Skip to main content
POST
Onboard user
Use this endpoint to onboard a new user/customer into the portal. This creates a complete account setup including registration, company, user, and workspace in a single API call.

Endpoint

POST /users/onboard Content-Type: application/json Authentication: Required (API token)

Request Body

Parameters

Notes

  • All four fields are required.
  • The email_id must not already be registered in the system.
  • The company_name must be unique — it cannot match an existing company.
  • The email domain is validated against restricted domains. If the domain is restricted, the request will be rejected.
  • A unique 12-digit customer_salt is auto-generated and returned in the response. This can be used later to generate API tokens via the Get Token by Customer ID endpoint.
  • The onboarded user is created as an Admin with a default workspace and 20 free minutes.

Success Response

Response Fields

Error Responses

Example cURL

Headers

token
string
required

API token for authentication

Body

application/json
email_id
string<email>
required

Email address of the user to onboard. Also accepts 'email'.

first_name
string
required

First name of the user. Also accepts 'firstName'.

last_name
string
required

Last name of the user. Also accepts 'lastName'.

company_name
string
required

Company name for the new account. Must be unique. Also accepts 'companyName'.

Response

User onboarded successfully

message
string
data
object