POST api/saveLeadExternal
Request Information
URI Parameters
None.
Body Parameters
saveLeadExternalRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| clientCode | string |
Required |
|
| channelCode | string |
None. |
|
| branchCode | string |
None. |
|
| staffCode | string |
None. |
|
| profiles | saveLeadExternalProfile |
None. |
|
| opportunity | Collection of getOpportunity |
None. |
|
| address | Collection of saveLeadExternalAddress |
None. |
|
| consent | Collection of saveLeadExternalConsent |
None. |
Request Formats
application/json, text/json
Sample:
{
"clientCode": "sample string 1",
"channelCode": "sample string 2",
"branchCode": "sample string 3",
"staffCode": "sample string 4",
"profiles": {
"leadCode": "sample string 1",
"customerCode": "sample string 2",
"leadStatusCode": "sample string 3",
"leadType": "sample string 4",
"companyCode": "sample string 5",
"companyName": "sample string 6",
"titleName": "sample string 7",
"firstName": "sample string 8",
"middleName": "sample string 9",
"lastName": "sample string 10",
"citizenId": "sample string 11",
"passportId": "sample string 12",
"nationalityCode": "sample string 13",
"mobile": "sample string 14",
"telephone": "sample string 15",
"email": "sample string 16",
"facebookName": "sample string 17",
"facebookAds": "sample string 18",
"lineId": "sample string 19",
"birthday": "sample string 20",
"gender": "sample string 21",
"occupationId": "sample string 22",
"isForeign": "sample string 23",
"isActive": "sample string 24",
"leadRegisterDate": "sample string 25"
},
"opportunity": [
{
"oppId": "sample string 1",
"oppStatus": "sample string 2"
},
{
"oppId": "sample string 1",
"oppStatus": "sample string 2"
}
],
"address": [
{
"addressText": "sample string 1",
"provinceCode": "sample string 2",
"districtCode": "sample string 3",
"subDistrictCode": "sample string 4",
"zipCode": "sample string 5"
},
{
"addressText": "sample string 1",
"provinceCode": "sample string 2",
"districtCode": "sample string 3",
"subDistrictCode": "sample string 4",
"zipCode": "sample string 5"
}
],
"consent": [
{
"consentId": 1,
"memberID": "sample string 2",
"leadCode": "sample string 3",
"crmCode": "sample string 4",
"value": "sample string 5",
"isActive": "sample string 6"
},
{
"consentId": 1,
"memberID": "sample string 2",
"leadCode": "sample string 3",
"crmCode": "sample string 4",
"value": "sample string 5",
"isActive": "sample string 6"
}
]
}
application/xml, text/xml
Sample:
<saveLeadExternalRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VentilatorAPI.HTTP.Request">
<address>
<saveLeadExternalAddress>
<addressText>sample string 1</addressText>
<districtCode>sample string 3</districtCode>
<provinceCode>sample string 2</provinceCode>
<subDistrictCode>sample string 4</subDistrictCode>
<zipCode>sample string 5</zipCode>
</saveLeadExternalAddress>
<saveLeadExternalAddress>
<addressText>sample string 1</addressText>
<districtCode>sample string 3</districtCode>
<provinceCode>sample string 2</provinceCode>
<subDistrictCode>sample string 4</subDistrictCode>
<zipCode>sample string 5</zipCode>
</saveLeadExternalAddress>
</address>
<branchCode>sample string 3</branchCode>
<channelCode>sample string 2</channelCode>
<clientCode>sample string 1</clientCode>
<consent>
<saveLeadExternalConsent>
<consentId>1</consentId>
<crmCode>sample string 4</crmCode>
<isActive>sample string 6</isActive>
<leadCode>sample string 3</leadCode>
<memberID>sample string 2</memberID>
<value>sample string 5</value>
</saveLeadExternalConsent>
<saveLeadExternalConsent>
<consentId>1</consentId>
<crmCode>sample string 4</crmCode>
<isActive>sample string 6</isActive>
<leadCode>sample string 3</leadCode>
<memberID>sample string 2</memberID>
<value>sample string 5</value>
</saveLeadExternalConsent>
</consent>
<opportunity>
<getOpportunity>
<oppId>sample string 1</oppId>
<oppStatus>sample string 2</oppStatus>
</getOpportunity>
<getOpportunity>
<oppId>sample string 1</oppId>
<oppStatus>sample string 2</oppStatus>
</getOpportunity>
</opportunity>
<profiles>
<birthday>sample string 20</birthday>
<citizenId>sample string 11</citizenId>
<companyCode>sample string 5</companyCode>
<companyName>sample string 6</companyName>
<customerCode>sample string 2</customerCode>
<email>sample string 16</email>
<facebookAds>sample string 18</facebookAds>
<facebookName>sample string 17</facebookName>
<firstName>sample string 8</firstName>
<gender>sample string 21</gender>
<isActive>sample string 24</isActive>
<isForeign>sample string 23</isForeign>
<lastName>sample string 10</lastName>
<leadCode>sample string 1</leadCode>
<leadRegisterDate>sample string 25</leadRegisterDate>
<leadStatusCode>sample string 3</leadStatusCode>
<leadType>sample string 4</leadType>
<lineId>sample string 19</lineId>
<middleName>sample string 9</middleName>
<mobile>sample string 14</mobile>
<nationalityCode>sample string 13</nationalityCode>
<occupationId>sample string 22</occupationId>
<passportId>sample string 12</passportId>
<telephone>sample string 15</telephone>
<titleName>sample string 7</titleName>
</profiles>
<staffCode>sample string 4</staffCode>
</saveLeadExternalRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.