Creating Users

To create a User, you must first create an Organization and a Designation. If you have not done this, we recommend reading those topics before proceeding.

To create a User, call the Create User endpoint and specify the following required parameters in the request body:

Member

Description

Remarks

firstName

First name of the User.

designation

Designation of the User.

To retrieve a list of all existing Designations, use the Get all Designations endpoint.

category

Category of the user.

Valid values: Regular or Adhoc.

primaryMobile: countryCode
Required

3-4 character standard country code of the primary mobile number for the User.

primaryMobile: number
required

The primary mobile number.

employmentType

Type of employment.

Valid Values: Full-time, Part-time, Contract, or N/A.

Request bodies are specified in JSON format. The following example request body shows how to create a new User named John Smith:

{
    "firstName": "kashish",
    "lastName": "lala",
    "designation": "Field Executive", 
    "category": "Regular",
    "email": "[email protected]",
    "primaryMobile": {
        "countryCode": "+91",
        "number": "9999999999"
    },
    "employmentType": "Full-time"
}

Did this page help you?