Leads API

Request

Header Params

Authorization

string

required

LEADS_EXTERNAL_API_KEY - Will be provided by MASI

Example:

Content-Type

string

required

Example:

application/json

Accept

string

required

Example:

application/json

Body Params application/json

source

string

required

This field is mandatory. Value for this field will be provided by MASI. For development purposes use Test

moveType

enum<string>

optional

This is ENUM field. Allowed values listed below.

Allowed values:

INT_HOUSEHOLDINT_COMMERCIALDOM_HOUSEHOLDDOM_COMMERCIALLOCAL_HOUSEHOLDLOCAL_COMMERCIALLD_HOUSEHOLDLD_COMMERCIAL

volumeImperial

number

optional

Shipment volume in cubic feet (maxlength: 15 digits)

volumeMetric

number

optional

Shipment volume in cubic meters (maxlength: 15 digits)

weightImperial

number

optional

Shipment weight in pounds (maxlength: 15 digits)

weightMetric

number

optional

Shipment weight in kilograms (maxlength: 15 digits)

moveDate

string

optional

Shipment date, format YYYY/MM/DD ("2024/01/29")

customerDetails

object

optional

name

string

optional

Customer full name (maxlength: 60 characters)

emails

array [object {2}]

optional

phones

array [object {2}]

optional

movingFrom

object

optional

Moving From Address

fullAddress

string

optional

Full address line

<= 200 characters

apartment

string

optional

Apartment/Flat number

<= 10 characters

unitNo

string

optional

Unit number

<= 10 characters

buzzersCode

string

optional

Building buzzer code

<= 10 characters

floor

string

optional

Floor/Level

<= 10 characters

movingTo

object

optional

Moving From Address

fullAddress

string

optional

Full address line

<= 200 characters

apartment

string

optional

Apartment/Flat number

<= 10 characters

unitNo

string

optional

Unit number

<= 10 characters

buzzersCode

string

optional

Building buzzer code

<= 10 characters

floor

string

optional

Floor/Level

<= 10 characters

notes

string

optional

Notes, comments related to the lead, (maxlength 1000 characters)

<= 1000 characters

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 samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

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

message

string

required

lead

object

required

New Lead Data

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

API that provides ability to create leads in MASI for external suppliers#

Request

Request samples

Responses

API that provides ability to create leads in MASI for external suppliers