Purlin.LeadKit.Integration.Model 1.0.2

Leads API Integration

Overview

The Leads API provides a robust solution for managing lead information, enabling seamless integration with your sales, marketing, or CRM systems. This API allows you to create, update, and retrieve lead data, ensuring your applications are always synced with the latest information.

Features

• Create Leads: Add new leads into the system using the POST /v1/integration/Lead endpoint with detailed attributes.
• Update Leads: Modify the details of existing leads using the PUT /v1/integration/Lead endpoint.
• Filter Leads: Retrieve a list of leads based on specified criteria using the POST /v1/integration/Lead/filter endpoint.

Getting Started

Before you can start using the API, you'll need to set up an account and obtain your unique API key. This key is required to authenticate your requests.

Prerequisites

• An active account with access to the Leads API.
• API key, obtained after registration.

Installation

No installation is required. You can directly call the API endpoints over HTTP/S protocol.

Usage

Here are basic examples of how to make requests to the API:

Create a New Lead

POST /v1/integration/Lead
Host: leads-api.purlin.com
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "email": "example@email.com",
  "externalId": "12345",
  "fullName": "John Doe",
  "userAction": "interested"
}

Update an Existing Lead

PUT /v1/integration/Lead
Host: leads-api.purlin.com
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "id":123
  "email": "updated@example.com",
  "externalId": "12345",
  "fullName": "Jane Doe",
  "userAction": "contacted"
}

Filter Leads

POST /v1/integration/Lead/filter
Host: leads-api.purlin.com
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "conditions": [
    {
      "property": "email",
      "operator": "eq",
      "value": "query@example.com"
    }
  ]
}

API Endpoints

• POST /v1/integration/Lead: Creates a new lead with the provided details.
• PUT /v1/integration/Lead: Updates the lead details for the specified ID.
• POST /v1/integration/Lead/filter: Filters leads based on the provided query conditions.

Security

The API uses OAuth2 for authentication, ensuring secure access and data integrity. Ensure to use HTTPS to encrypt data in transit.

Support

For any issues or questions regarding the API, please contact our support team or refer to the online documentation and FAQs.