OpenAPI definition

create new lead

POST /lead-platform/v1/leads/create

change lead status

PUT /lead-platform/v1/leads/changeStatus

POST /lead-platform/v1/leads/create

Request headers

source

string required

Enumeration:

TCB

Request body

application/json

LeadCreateDto

Responses

500 500

Internal Server Error

Body

*/*

BaseResponseVoid

201 201

Created

Body

*/*

BaseResponseRawLeadDto

PUT /lead-platform/v1/leads/changeStatus

Request headers

source

string required

Enumeration:

TCB

Request body

application/json

LeadSourceUpdateStatusDto

Responses

500 500

Internal Server Error

Body

*/*

BaseResponseVoid

200 200

OK

Body

*/*

BaseResponseVoid

Object

code

integer int32

data

Object

meta

Metadata

Object

code

integer int32

page

integer int32

size

integer int32

total

integer int64

message

string

Object

name

string required

mobileNumber

string required

homePhone

string

email

string

gender

string

Enumeration:

MALE

FEMALE

birthDate

string date

idNumber

string

familyBook

string

passport

string

maritalStatus

string

Enumeration:

SINGLE

MARRIED

DIVORCED

WIDOWED

SEPARATED

LIVING_WITH_PARTNER

demand

string

projectId

string

projectCode

string

projectName

string

houseType

string

housePrice

string

houseInformation

string

agentId

integer int64

agentCode

string

communicationType

string

interactionType

string

sourceOrigin

string

contactType

string

houseNumber

string

street

string

regionCode

string

districtCode

string

wardCode

string

homeDirections

Array

string

Enumeration:

NORTHEAST

SOUTHEAST

NORTHWEST

SOUTHWEST

SOUTHEAST_SOUTHWEST

NORTHWEST_SOUTHWEST

NORTHEAST_SOUTHWEST

NORTHEAST_NORTHWEST

EAST

WEST

SOUTH

NORTH

balconyDirections

Array

string

Enumeration:

NORTHEAST

SOUTHEAST

NORTHWEST

SOUTHWEST

SOUTHEAST_SOUTHWEST

NORTHWEST_SOUTHWEST

NORTHEAST_SOUTHWEST

NORTHEAST_NORTHWEST

EAST

WEST

SOUTH

NORTH

show more

Object

houseNumber

string

street

string

regionCode

string

districtCode

string

wardCode

string

fullAddress

string

Object

lead_source_id

string

name

string

mobile_number

string

email

string

gender

string

Enumeration:

MALE

FEMALE

birth_date

string date-time

project_code

string

project_name

string

house_type

string

Enumeration:

HT3000

HT3001

HT3002

HT3003

house_information

string

Enumeration:

HI4000

HI4002

HI4003

HI4004

HI4005

HI4006

HI4007

HI4008

HI4009

HI4010

house_price

string

request_time

string date-time

meeting_time

string date-time

channel

string

status

string

note

string

sale

LeadSaleDto

lead_score

integer int32

address

string

city_code

string

district_code

string

ward_code

string

show more

Object

sale_id

string

sale_name

string

sale_mobile_number

string

sale_email

string

project_code

string

Object

code

integer int32

data

RawLeadDto

meta

Metadata

Object

id

string uuid

Object

lead_source_id

string

status

string

Object

fullName

string required

phoneNumber

string required

Pattern: (03|07|08|09|01[2|6|8|9])+([0-9]{8})

email

string required

demand

string required

project

string required

source

string

purpose

string

apartment

string

gender

string

Enumeration:

MALE

FEMALE

address

string

idNumber

string

apartmentType

string

balconyView

string

birthDay

string date

show more