Leads API
POST
https://{{subscriber_name}}.masi-leap.com/v1/x-lead-external-api/new-lead
API that provides ability to create leads in MASI for external suppliers#
1.
2.
3.
Request
Header Params
Body Params application/json
Example
{
"source": "string",
"moveType": "INT_HOUSEHOLD",
"volumeImperial": 0,
"volumeMetric": 0,
"weightImperial": 0,
"weightMetric": 0,
"moveDate": "string",
"customerDetails": {
"name": "string",
"emails": [
{
"value": "string",
"type": "string"
}
],
"phones": [
{
"value": "string",
"type": "string"
}
]
},
"movingFrom": {
"fullAddress": "string",
"apartment": "string",
"unitNo": "string",
"buzzersCode": "string",
"floor": "string"
},
"movingTo": {
"fullAddress": "string",
"apartment": "string",
"unitNo": "string",
"buzzersCode": "string",
"floor": "string"
},
"notes": "string"
}Request Code Samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'https://{{subscriber_name}}.masi-leap.com/v1/x-lead-external-api/new-lead' \
--header 'Authorization: {{LEADS_EXTERNAL_API_KEY}}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
"source": "string",
"moveType": "INT_HOUSEHOLD",
"volumeImperial": 0,
"volumeMetric": 0,
"weightImperial": 0,
"weightMetric": 0,
"moveDate": "string",
"customerDetails": {
"name": "string",
"emails": [
{
"value": "string",
"type": "string"
}
],
"phones": [
{
"value": "string",
"type": "string"
}
]
},
"movingFrom": {
"fullAddress": "string",
"apartment": "string",
"unitNo": "string",
"buzzersCode": "string",
"floor": "string"
},
"movingTo": {
"fullAddress": "string",
"apartment": "string",
"unitNo": "string",
"buzzersCode": "string",
"floor": "string"
},
"notes": "string"
}'Responses
🟢200Success
application/json
Body
Example
{
"message": "Success!",
"lead": {
"_id": "673f75bede30c05d9eafad5d",
"leadId": "MLD-1",
"source": "Website",
"moveType": "LD_HOUSEHOLD",
"volumeImperial": 23,
"volumeMetric": 7,
"weightImperial": 100,
"weightMetric": 20,
"moveDate": "2025/03/27",
"customerDetails": {
"name": "John Wick",
"emails": [
{
"value": "jv@test.com",
"type": "Primary"
}
],
"phones": [
{
"value": "+1-555-3451235",
"type": "Primary"
}
]
},
"movingFrom": {
"fullAddress": "Amphoe Mueang Krabi, Chang Wat Krabi 81000, Thailand",
"apartment": "240",
"unitNo": "11",
"buzzersCode": "*2435#",
"floor": "23"
},
"movingTo": {
"fullAddress": "Sheikh Zayed Rd - Al Sufouh 2 - Dubai - United Arab Emirates",
"apartment": "89",
"unitNo": "43",
"buzzersCode": "*9999#",
"floor": "11"
},
"notes": "Customer requires special services"
}
}🟠406Bad Request
🔴500Server Error
Modified at 2025-08-18 11:38:49