🚀 API Documentation - Overview

Welcome to the API documentation! This guide provides everything you need to integrate our APIs seamlessly into your application.

📌 What is this API for?

This API allows developers to interact with our system to manage leads, retrieve data, and automate processes efficiently. Whether you want to create leads, fetch reports, or analyze data, our APIs provide a robust and scalable way to do so.

✅ Prerequisites

Before using this API, make sure you have:

An Account: You must be a registered user to access the API. If you don’t have an account, sign up on our platform.
An API Key: Authentication is required for all API requests. You can find your API key in your account settings.

🔐 How to Get Your API Key?

Log in to your account.
Navigate to the Organization Settings page by clicking on the Your Organization option inside the profile dropdown.
Keep your API key safe! Do not share it publicly.

📖 Quick Links

🔗 Email Related Endpoints

Verify Email

🔗 WhatsApp Related Endpoints

Send Message

🔗 Leads Related Endpoints

Create Leads

⚡ Making Your First API Call

To test the API, you can use cURL or Postman. Here’s a simple example to create a lead:


bash
curl -X POST /api/leads \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '[
    {
      "firstName": "Jane",
      "lastName": "Smith",
      "email": "jane.smith@example.com"
    }
  ]'

If everything is correct, you should receive a response like this (Response may vary):


json
{
  "message": "Successfully created leads",
  "duplicates": 0,
  "created": 1
}

❗ Important Notes

All API requests must include the x-api-key header.
Always validate responses to handle errors gracefully.
Some endpoints may require additional permissions depending on your plan.

🛠 Need Help?

If you have any questions or need support, check out:

Support Team - Contact us for direct assistance support@skyfunnel.ai

Feel free to share your experience and connect with us via our social links

Start building with our API today! 🚀