Creating a Dealer / Sub-Dealer User
- Endpoint:
/vendor/users - HTTP Method:
POST - Request Content-Type:
application/json - Response Content-Type:
application/json - Authorization: Valid AccessToken is required. (See: 2. Authentication – Obtaining AccessToken)
Description
This service is used to create new user(s) under an existing dealer or sub-dealer. By specifying a DealerCode already registered in the system, users are added to the corresponding membership.
Note: This endpoint does not create or update dealer or sub-dealer records — it only adds users to an existing dealer.
Header Information
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | Valid token in Bearer {AccessToken} format |
| Content-Type | Yes | application/json |
Request Body
Top-Level Fields
| Field | Type | Required | Description |
|---|---|---|---|
| DealerCode | string | Yes | Membership code of the dealer or sub-dealer to which users will be added. |
| users | array | Yes | List of users to be added (must contain at least 1 item). |
User (Dealer & Sub-Dealer User) Fields
| Field | Type | Required | Description |
|---|---|---|---|
| code | string | Yes | User code (must be unique). |
| name | string | Yes | User first name. |
| surname | string | Yes | User last name. |
| string | Yes | User email address. | |
| gsm | string | Yes | Mobile phone number. |
| title | string | No | Title. |
| description | string | No | Description. |
| erpCode | string | No | User ERP code (if any, must be unique). |
| isActive | boolean | No | Active/inactive status (default: true). |
| isForeignNational | boolean | No | Is the user a foreign national. |
| canUseMobile | boolean | No | Permission for mobile usage (default: false). |
| roles | array | No | List of role IDs. |
| ruleName | array | No | Names of permission sets. |
| sendMail | boolean | No | Should a registration email be sent (default: false). |
| taxNumber | string | No | Tax number. |
| taxOffice | string | No | Tax office. |
| userType | integer | No | Type of user. |
Example Request
{
"dealerCode": "NT23421002",
"users": [
{
"canUseMobile": true,
"description": "test",
"email": "[email protected]",
"erpCode": "4414",
"code": "4414",
"gsm": "5000000000",
"isActive": true,
"name": "test vendor",
"surname": "user",
"roles": [
"a6f75072-4378-4db2-b432-9862335730d0"
],
"sendMail": true,
"userType": 4,
"tckn": "00000000000"
}
]
}
The DealerCode field represents the membership code of the dealer or sub-dealer to which the users will be added.
Multiple users can be added in a single request using the same endpoint.
Successful Response (200 OK)
{
"status": "success",
"message": "Dealer user has been successfully created.",
"customerId": 1024
}
Notes & Best Practices
dealerCodemust be a dealer or sub-dealer code already registered in the system; otherwise the request returns404 Not Found.- Multiple users can be added in a single request.
- Each user's
code,email, andgsmvalues must be unique. - If
sendMail = true, a registration notification email is automatically sent to the user. - The
rolesandruleNamefields are optional but recommended for authorization processes. - If the token has expired, the request returns
401 Unauthorized; a new token must be obtained and the request retried.