Overview
This document describes the APIs introduced as part of the CRM Logixx update to support user creation and user deactivation.
These APIs allow external systems to programmatically manage user lifecycle within CRM Logixx.
This functionality ensures:
Centralized user lifecycle management
Reduced manual administration
Improved data consistency across systems
Prerequisites
Before using the API endpoints, ensure the following:
Valid API credentials (API Key / Token)
Proper permissions to manage users
Access to the correct Organization (ORG) context
Create User via API
Description
Creates a new user in Logixx CRM and assigns default roles and permissions.
The following fields are mandatory when creating a user via the API. Requests missing any of these fields will be rejected.
Required Fields
Field | Description |
userName | Unique username used for system authentication. Must be unique across the platform. |
name | User’s given (first) name. |
surname | User’s family (last) name. |
emailAddress | User’s email address used for communication and login (if applicable). Must be unique. |
password | User’s password for authentication. Must comply with system password policy (length, complexity, etc.). |
Optional Fields
Field | Description | Lookup Endpoint |
isActive | Whether the user is active (default: | – |
roleNames | Roles assigned to the user |
|
branchId | Branch assigned to the user |
|
phoneNumber | User phone number (must be valid format) | – |
leadRoleId | Lead role for lead assignment |
|
profileImage | Profile image URL | – |
subscriptionIds | Assigned subscriptions |
|
Default Behavior
When a user is created using only the required fields:
The user account is created successfully
The user is active by default
The user is able to log in immediately after creation
Successful Response
HTTP Status Code: 200 – Created
Result: User is created successfully
Deactivate User vía API
Endpoint
POST /api/users/{id}/deactivateDescription
Deactivates an existing user account. The user will no longer be able to log in, but all user data is preserved.
Path Parameters
Parameter | Description |
| Unique identifier of the user |
Successful Response
Status Code: 200 OK
Response:
User deactivated successfully
Activate User via API
This endpoint allows authorized systems to activate an existing user account in the CRM. Once activated, the user will be able to log in and access the system based on their assigned permissions.
Endpoint
POST /api/users/{id}/activateDescription
Activates a user account that is currently inactive. This operation changes the user’s status to active without modifying any existing user data.
Path Parameters
Parameter | Description |
| Unique identifier of the user to activate |
Successful Response
HTTP Status Code: 200 OK
Response Message:
Indicates that the user was activated successfully
The Logixx API for user creation and deactivation enables efficient, secure, and scalable user lifecycle management. Proper implementation ensures consistency between external systems and the CRM while maintaining compliance and auditability.