Skip to main content

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

HeaderRequiredDescription
AuthorizationYesValid token in Bearer {AccessToken} format
Content-TypeYesapplication/json

Request Body

Top-Level Fields

FieldTypeRequiredDescription
DealerCodestringYesMembership code of the dealer or sub-dealer to which users will be added.
usersarrayYesList of users to be added (must contain at least 1 item).

User (Dealer & Sub-Dealer User) Fields

FieldTypeRequiredDescription
codestringYesUser code (must be unique).
namestringYesUser first name.
surnamestringYesUser last name.
emailstringYesUser email address.
gsmstringYesMobile phone number.
titlestringNoTitle.
descriptionstringNoDescription.
erpCodestringNoUser ERP code (if any, must be unique).
isActivebooleanNoActive/inactive status (default: true).
isForeignNationalbooleanNoIs the user a foreign national.
canUseMobilebooleanNoPermission for mobile usage (default: false).
rolesarrayNoList of role IDs.
ruleNamearrayNoNames of permission sets.
sendMailbooleanNoShould a registration email be sent (default: false).
taxNumberstringNoTax number.
taxOfficestringNoTax office.
userTypeintegerNoType 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

  • dealerCode must be a dealer or sub-dealer code already registered in the system; otherwise the request returns 404 Not Found.
  • Multiple users can be added in a single request.
  • Each user's code, email, and gsm values must be unique.
  • If sendMail = true, a registration notification email is automatically sent to the user.
  • The roles and ruleName fields 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.