Add Lead API

Create a new lead in Membroz using the Prospect API.

Endpoint

Method	Endpoint
POST	`/api/prospects/`

Base URL: https://app.membroz.com

Required Headers

Header	Value
Content-Type	`application/json`
authkey	Your client-specific private API key

Request Body

Send the lead information in JSON format.

{
  "property": {
    "firstname": "John",
    "lastname": "Smith",
    "i_m_interested_in": "Planning a Stay",
    "primaryemail": "john@example.com",
    "mobile": "+919876543210",
    "remark": "Interested in Membroz services"
  }
}

Request Parameters

Field	Type	Description
firstname	String	Lead's first name
lastname	String	Lead's last name
i_m_interested_in	String	Service or offering of interest
primaryemail	String	Lead's email address
mobile	String	Mobile number with country code
remark	String	Additional information

cURL Example

curl --location 'https://app.membroz.com/api/prospects/' \
--header 'Content-Type: application/json' \
--header 'authkey: YOUR_CLIENT_API_KEY' \
--data '{
  "property": {
    "firstname": "John",
    "lastname": "Smith",
    "i_m_interested_in": "Planning a Stay",
    "primaryemail": "john@example.com",
    "mobile": "+919876543210",
    "remark": "Interested in Membroz services"
  }
}'

Responses

201 – Created

The lead was created successfully.

409 – Conflict

A lead with the same email address or mobile number already exists.

Important Notes

Use the private API key assigned to your organization.
Include the authkey header in every request.
Send the request body in valid JSON format.
Duplicate email addresses or mobile numbers return a conflict response.

Getting Started