← Home Create User

Create User

POSThttps://api.bayut.com/v1/users

This endpoint creates a new user.

🔐 Bearer Token: Provide your bearer token in the Authorization header when making requests to protected resources.

Query Parameters

Name	Type	Required	Description	Example
name	string	Optional	The name of the user.	<= 255 characters
email	string	Optional	A unique email address for the user, not already registered in ProFolio.	john.doe@bayut.com
password	string	Optional	Requires a minimum of 8 characters, including at least one of each: an uppercase letter, a lowercase letter, a symbol, and a number.	>= 8 characters
phone	string	Optional	The user's phone number in E.164 format	+971501234567
cell	string	Optional	The user's phone number in E.164 format
whatsapp	string	Optional	The user's phone number in E.164 format
gender	string	Optional	The gender of the user.	Male
about	string	Optional	The description of the user.
experience	integer	Optional	The experience in years, from 0 to 50.	>= 0
agency_id	integer	Optional	The agency ID of the user.
role	string	Optional	The role of the user.	agent
country_id	integer	Optional	The unique identifier for the country. See theGET v1/countriesendpoint for a list of valid IDs.
areas	array[integer]	Optional	The speciality areas of the user.	>= 1 items
specialities	array[integer]	Optional
languages	array[integer]	Optional
social_medias	array[integer]	Optional
teams	array[string]	Optional	The teams of the user.
Accept	string	Optional		application/json
message	string	Optional	A general message regarding successful user creation.

Response Schema

Name	Type	Required	Description	Example
data	object	Optional	The data of the newly created User.
id	string	Optional	The ID of the user.
image	string	Optional	The URL pointing to the User's profile picture.
experience_in_years	integer	Optional
country	object	Optional	The unique identifier for the country. See theGET v1/countriesendpoint for a list of valid IDs.
brn_number	string	Optional	The Broker Registration Number (BRN) of the user.	john.doe@bayut.com
bln_number	string	Optional	The Broker License Number (BLN) of the user.
contact	object	Optional	Requires a minimum of 8 characters, including at least one of each: an uppercase letter, a lowercase letter, a symbol, and a number.
agency	object	Optional	The Agency of the user.

Responses

201✅

422⚠️

401⚠️

403⚠️

Code Examples

curl --location 'https://api.bayut.com/v1/users' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "name": "John Doe",
  "email": "john.doe@bayut.com",
  "password": "B@yut123#",
  "phone": "+971501234567",
  "cell": "+971501234568",
  "whatsapp": "+971501234569",
  "gender": "male",
  "about": "Experienced real estate professional with 5+ years in the UAE market, specializing in luxury properties and commercial real estate.",
  "experience": 5,
  "agency_id": 102917,
  "role": "agent",
  "country_id": 1,
  "areas": [5001, 5002, 5003],
  "specialities": [1, 2, 3],
  "languages": [1, 6],
  "social_medias": [
    {
      "platform_id": 1,
      "url": "https://www.linkedin.com/in/johndoe"
    },
    {
      "platform_id": 2,
      "url": "https://www.instagram.com/johndoe"
    }
  ]
}'

{
    "message": "User created successfully",
    "data": {
        "id": 2594713,
        "name": {
            "en": "John Doe",
            "ar": null
        },
        "about": "Experienced real estate professional with 5+ years in the UAE market, specializing in luxury properties and commercial real estate.",
        "gender": "male",
        "image": null,
        "experience_in_years": 5,
        "country": {
            "en": "Afghanistan",
            "ar": "أفغانستان"
        },
        "brn_number": null,
        "bln_number": null,
        "contact": {
            "email": "john.doe@bayut.com",
            "phone": "+971501234567",
            "cell": "+971501234568",
            "whatsapp": "+971501234569"
        },
        "role": "agent",
        "agency": {
            "id": 102917,
            "name": "Lake city real estate"
        },
        "teams": [],
        "languages": [
            "English",
            "Arabic"
        ],
        "social_medias": [
            {
                "platform": "Facebook",
                "url": "https://www.linkedin.com/in/johndoe"
            },
            {
                "platform": "Instagram",
                "url": "https://www.instagram.com/johndoe"
            }
        ],
        "specialities": [
            "Residential Sales",
            "Residential Leasing",
            "Commercial Sales"
        ],
        "speciality_areas": [
            {
                "en": "UAE",
                "ar": "الإمارات"
            },
            {
                "en": "Dubai",
                "ar": "دبي"
            },
            {
                "en": "Dubai Marina",
                "ar": "دبي مارينا"
            }
        ]
    }
}