Sign in
users

Create a new user

Create a new user. For staff users (admin, marketing, customer support, operation), upline_id and network relationships are ignored. For regular users, commission_plan_id is required.

post/users

Request body

namestring required

User full name

emailstring required

User email address

passwordstring

User password (optional, min 6 characters)

commission_plan_idnumber

Commission plan ID (required for regular users, optional for staff)

upline_idnumber

Upline user ID (optional, ignored for staff users)

takaful_status'active' | 'inactive'

Takaful status

email_verifiedboolean

Email verified status

role_idsnumber[]

Array of role IDs to assign to user (admin, marketing, customer support, operation)

Example request

{
  "name": "John Doe",
  "email": "john.doe@example.com",
  "password": "password123",
  "commission_plan_id": 1,
  "upline_id": 1,
  "takaful_status": "inactive",
  "role_ids": [
    1,
    2
  ]
}

Response

User created successfully

user_idnumber required
namestring required
emailstring required
email_verifiedboolean required
email_verified_atstring date-time nullable
upline_idnumber nullable
registration_datestring date-time required
takaful_status'active' | 'inactive' required
commission_plan_idnumber required

Example response

{
  "user_id": 1,
  "name": "John Doe",
  "email": "john.doe@example.com",
  "registration_date": "2024-01-01T00:00:00.000Z",
  "takaful_status": "inactive",
  "commission_plan_id": 1,
  "roles": [
    {
      "user_role_id": 1,
      "role_id": 1,
      "role_name": "admin",
      "start_date": "2024-01-01T00:00:00.000Z"
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.