OpenAPI definition

create new lead

POST /lead-platform/v1/mplus/leads/create

change lead status

PUT /lead-platform/v1/mplus/leads/changeStatus

POST /lead-platform/v1/mplus/leads/create

Authentication

Open

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/mplus/leads/changeStatus

Authentication

Open

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

houseNumber

string

street

string

regionCode

string

districtCode

string

wardCode

string

fullAddress

string

Object

lead_source_id

string required

name

string required

mobile_number

string required

email

string

gender

string

Enumeration:

MALE

FEMALE

birth_date

string date-time

project_code

string required

project_name

string required

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 required

meeting_time

string date-time

channel

string

status

string

note

string

sale

LeadSaleDto required

lead_score

integer int32 required

address

string

city_code

string

district_code

string

ward_code

string

string

show more

Object

sale_id

string required

sale_name

string required

sale_mobile_number

string required

sale_email

string

project_code

string

Object

code

integer int32

data

RawLeadDto

meta

Metadata

Object

id

string uuid

Object

lead_source_id

string required

status

string required

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