API Documentation

Adds a new user to the CRM database under the active admin account. Accepts JSON payloads or standard Form URL-Encoded POST requests.

Request Parameters

Parameter	Type	Required	Description
name	string	Yes	Full name of the user.
email	string	Yes	Unique email address (validated format).
mobile	string	Yes	Mobile phone number of the user.
admin_id	integer	No	Optional admin ID to link user to. Defaults to the first admin in the database.

JSON Request Body Example

{
    "name": "Jane Doe",
    "email": "[email protected]",
    "mobile": "+1234567890",
    "admin_id": 1
}

Response Format (201 Created)

{
    "success": true,
    "message": "User added successfully.",
    "user": {
        "id": 14,
        "name": "Jane Doe",
        "email": "[email protected]",
        "mobile": "+1234567890"
    }
}

Queries application state for a user. Checked by client applications during user launch to block/stop access.

Request Parameters

Parameter	Type	Required	Description
email	string	Conditional	The email address of the user. (Pass either email or mobile).
mobile	string	Conditional	The mobile phone number of the user.

Response Format (200 OK)

{
    "success": true,
    "user": {
        "id": 14,
        "name": "Jane Doe",
        "email": "[email protected]",
        "mobile": "+1234567890"
    },
    "stop_app": false,
    "expiry_date": "2026-12-31 23:59:59",
    "is_expired": false,
    "last_opened_at": "2026-08-17 12:25:00"
}

Checks the latest version and update type for Android or iOS platforms.

Request Parameters

Parameter	Type	Required	Description
application	string	Yes	Target platform value: android or ios.

Response Format (200 OK)

{
    "success": true,
    "platform": "android",
    "latest_version": "1.2.5",
    "update_type": "major"
}