Create User

HTTP Request

POSThttps://staging.api-gw.propdata.net/users/api/v1/agents/

Example Response

{
"id": 0,
"site": 0,
"archive_agent_action": {
"action": "string",
"assign_to_agent": 0
},
"active": false,
"username": "user@example.com",
"full_name": "string",
"portals": [],
"designation": 0,
"meta": {},
"created": "2021-03-01T14:10:07.054Z",
"modified": "2021-03-01T14:10:07.054Z",
"deleted": "2021-03-01T14:10:07.054Z",
"uuid": "770bba28-9f80-4d40-9c51-6e022364af91",
"source_ref": "string",
"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"id_number": "string",
"user_website": "string",
"country_code": "string",
"cell_number": "string",
"resume": "string",
"privy_seal_id": "string",
"facebook_url": "http://www.example.com",
"twitter_url": "http://www.example.com",
"linkedin_url": "http://www.example.com",
"youtube_url": "http://www.example.com",
"blog_url": "http://www.example.com",
"pinterest_url": "http://www.example.com",
"google_my_businees_url": "http://www.example.com",
"instagram_url": "http://www.example.com",
"physical_address": "string",
"postal_address": "string",
"home_number": "string",
"income_tax_ref_number": "string",
"fidelity_fund_number": "string",
"affairs_board_exam": false,
"bank": "string",
"account_holder": "string",
"account_number": "string",
"bank_branch": "string",
"bank_branch_code": "string",
"account_type": "string",
"tax_name_of_firm": "string",
"tax_consultant_name": "string",
"tax_physical_address": "string",
"tax_postal_address": "string",
"tax_office_number": "string",
"tax_fax": "string",
"tax_email_address": "user@example.com",
"facebook_campaign_key": "string",
"adwords_campaign_key": "string",
"profile_picture_coord_x": -2147483648,
"profile_picture_coord_y": -2147483648,
"profile_picture_width": -2147483648,
"profile_picture_height": -2147483648,
"commencement_date": "2021-03-01T14:10:07.054Z",
"image": -2147483648,
"documents": [],
"branches": [],
"display_on_branches": [],
"activate_account_hash": "string",
"activate_account_expires": "2021-03-01T14:10:07.054Z",
"account_activated": false,
"serviced_locations": [],
"serviced_listing_types": [],
"statistics": 0,
"group": 0,
"race": 0,
"user": 0,
"pending_user": 0
}

NameDescription

id

integer

ID

site

integer

Site

archive_agent_action

object

active

required

boolean

Active

username

nullable

string

Username

full_name

stringnon-empty

Full name

portals

array

Choices: [ 1,2,3...2147483648 ]

designation

required

integer

Designation

meta

string

Meta

created

string

Created

modified

string

Modified

deleted

string

Deleted

uuid

string

Uuid

source_ref

nullable

string<= 100 characters

Source ref

first_name

required

string[ 1...50 ] characters

First name

last_name

required

string[ 1...50 ] characters

Last name

email

required

string[ 1...254 ] characters

Email

id_number

nullable

string<= 13 characters

Id number

user_website

nullable

string<= 50 characters

User website

country_code

nullable

string<= 10 characters

Country code

cell_number

required

string[ 1...20 ] characters

Cell number

resume

nullable

string

Resume

privy_seal_id

nullable

string<= 200 characters

Privy seal id

facebook_url

nullable

string<= 200 characters

Facebook url

twitter_url

nullable

string<= 100 characters

Twitter url

linkedin_url

nullable

string<= 100 characters

Linkedin url

youtube_url

nullable

string<= 100 characters

Youtube url

blog_url

nullable

string<= 100 characters

Blog url

pinterest_url

nullable

string<= 100 characters

Pinterest url

google_my_businees_url

nullable

string<= 100 characters

Google my businees url

instagram_url

nullable

string<= 100 characters

Instagram url

physical_address

nullable

string

Physical address

postal_address

nullable

string

Postal address

home_number

nullable

string<= 20 characters

Home number

income_tax_ref_number

nullable

string<= 30 characters

Income tax ref number

fidelity_fund_number

nullable

string<= 30 characters

Fidelity fund number

affairs_board_exam

boolean

Affairs board exam

bank

nullable

string<= 30 characters

Bank

account_holder

nullable

string<= 30 characters

Account holder

account_number

nullable

string<= 30 characters

Account number

bank_branch

nullable

string<= 30 characters

Bank branch

bank_branch_code

nullable

string<= 30 characters

Bank branch code

account_type

nullable

string<= 30 characters

Account type

tax_name_of_firm

nullable

string<= 30 characters

Tax name of firm

tax_consultant_name

nullable

string<= 30 characters

Tax consultant name

tax_physical_address

nullable

string

Tax physical address

tax_postal_address

nullable

string

Tax postal address

tax_office_number

nullable

string<= 30 characters

Tax office number

tax_fax

nullable

string<= 30 characters

Tax fax

tax_email_address

nullable

string<= 30 characters

Tax email address

facebook_campaign_key

nullable

string<= 50 characters

Facebook campaign key

adwords_campaign_key

nullable

string<= 50 characters

Adwords campaign key

profile_picture_coord_x

nullable

integer

Profile picture coord x

profile_picture_coord_y

nullable

integer

Profile picture coord y

profile_picture_width

nullable

integer

Profile picture width

profile_picture_height

nullable

integer

Profile picture height

commencement_date

nullable

string

Commencement date

image

nullable

integer

Image

documents

nullable

array of integers

Documents

Choices: [ 1,2,3...2147483648 ]

branches

required

array of integers

Branches

Choices: [ 1,2,3...2147483648 ]

display_on_branches

nullable

array of integers

Display on branches

Choices: [ 1,2,3...2147483648 ]

activate_account_hash

nullable

string<= 250 characters

Activate account hash

activate_account_expires

nullable

string

Activate account expires

account_activated

boolean

Account activated

serviced_locations

nullable

array of integers

Serviced locations

Choices: [ 1,2,3...2147483648 ]

serviced_listing_types

nullable

array of strings

Serviced listing types

Choices: ResidentialResidential New DevelopmentResidential EstateCommercialCommercial New DevelopmentCommercial EstateIndustrialRetailAgriculturalMixed UseHoliday Letting

statistics

nullable

integer

Statistics

group

nullable

integer

Group

race

nullable

integer

Race

user

nullable

integer

User

pending_user

nullable

integer

Pending user

Responses

201
400 Bad request body
403 You do not have permission to perform this action
500 Internal server error
503 This website is not active