Getting Started

Welcome to the Membroz Open API documentation.

Membroz Open API allows external applications, integration partners, and developers to connect with Membroz services and exchange information programmatically.

Use this guide to understand the API requirements and make your first API request.

1. Prerequisites

Before integrating with Membroz Open API, make sure you have:

• A valid Membroz API key.
• Access to the Membroz API services.
• Basic knowledge of REST APIs and JSON.
• An API testing tool such as Postman or cURL.

Contact Membroz API Support to obtain your API credentials.

2. Base URL

All API requests should use the following base URL:

https://app.membroz.com

For example, the Create Prospect endpoint is:

POST https://app.membroz.com/api/prospects/

3. Request Format

Membroz APIs use JSON for request and response data.

Include the following headers in your requests:

Replace YOUR_API_KEY with the API key provided by Membroz.

For more details, see the Authentication guide.

4. Your First API Request

The following example demonstrates how to create a prospect using Membroz Open API.

cURL Example

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

Successful Response

A successful prospect creation request returns HTTP status 201 Created.

The response contains the created prospect information.

Possible Error Response

5. API Guidelines

• Always include your API key in the authkey header.
• Send request data in valid JSON format.
• Use the correct HTTP method for each endpoint.
• Validate request parameters before sending requests.
• Handle API responses and errors appropriately.
• Keep your API credentials secure.

6. Available API Categories

Membroz Open API documentation currently includes:

• Prospects – Create and manage prospect information.

Additional API categories will be documented as they become available.

7. Need Help?

For API credentials, integration assistance, or technical support, contact:

Membroz API Support

Website: https://www.membroz.com/