Skip to main content

​
What is Botista?

Botista is a multi-channel AI-powered chatbot platform that enables businesses to automate customer interactions across WhatsApp, Messenger, Instagram, and TikTok. Built with advanced language models, Botista helps businesses streamline customer support, lead generation, marketing campaigns, and order management through intelligent conversational AI.

​
Overview

The Botista External API provides public endpoints for integrating external systems with Botista’s contact management system. These endpoints allow you to programmatically add contacts to your contact lists from websites, CRM systems, e-commerce platforms, and other third-party applications without requiring user authentication.

​
Use Cases

The External API is perfect for:
  • Web Form Integrations - Capture leads directly from your website forms
  • E-commerce Sync - Add customers from online stores to marketing lists
  • CRM Integration - Synchronize contacts from external CRM systems
  • Event Registrations - Add event attendees to communication lists
  • Landing Pages - Capture leads from marketing landing pages
  • Third-party Platforms - Connect any external system to Botista

​
Base URL

All API requests should be made to: 
https://api.botista.com/api/v1/external

​
Available Endpoints

The External API currently supports:

Create Contact

Add new contacts to your contact lists

​
How It Works

  1. Create Contact Lists in your Botista dashboard (or via the main API)
  2. Configure Custom Variants for additional contact data fields (optional)
  3. Get Your Contact List ID from the Botista dashboard
  4. Integrate using the External API to add contacts from your external systems
  5. Automate your chatbot campaigns with enriched contact data
Once contacts are added via the External API, they become available for:
  • AI-powered chatbot conversations across WhatsApp, Messenger, Instagram, and TikTok
  • Targeted marketing campaigns with personalized messaging
  • Lead nurturing through automated follow-ups
  • Customer segmentation using custom variants
  • Order and transaction tracking

​
Authentication

External API endpoints use guest authentication via Laravel Sanctum, meaning:
  • No API keys or user credentials required
  • Public endpoints designed for server-to-server communication
  • Rate limiting applied to prevent abuse
  • Contact lists are identified by their unique IDs
Security Note: While these endpoints don’t require authentication, they should only be called from your secure backend servers. Never expose contact list IDs in client-side code or public repositories.

​
Rate Limiting

API requests are rate-limited to prevent abuse. If you exceed the rate limit, you’ll receive a 429 Too Many Requests response.
Implement exponential backoff and retry logic when making bulk API requests to avoid hitting rate limits.

​
Response Format

All responses follow a consistent JSON format:

​
Success Response

{
  "success": true,
  "message": "Operation completed successfully",
  "data": { }
}

​
Error Response

{
  "success": false,
  "message": "Error message",
  "error": "Detailed error description"
}

​
Custom Variants

Botista supports custom variants - additional fields you can define for each contact list. Variants enable you to:
  • Store custom business data (company name, position, source, etc.)
  • Segment contacts based on custom attributes
  • Personalize campaign messages with variant values
  • Track additional contact metadata
Variants must be configured in your contact list settings before they can be used via the API.
Each variant is identified by a unique slug (e.g., “company”, “source”, “utm_campaign”). Contact your Botista administrator to set up custom variants for your contact lists.

​
Getting Started

Ready to integrate? Follow these steps:
1

Get Your Contact List ID

Log into your Botista dashboard and navigate to your contact list to find its ID
2

Review the API Documentation

Check out the Create Contact endpoint for detailed request/response examples
3

Test Your Integration

Make a test API call from your development environment
4

Monitor Your Contacts

View newly added contacts in your Botista dashboard

​
Need Help?

If you need assistance with the API or have questions about integration:
  • Documentation: Review the detailed Create Contact endpoint documentation
  • Support: Contact your Botista account manager or support team
  • Dashboard: Access the Botista dashboard for contact list management
Next Steps: Learn how to create contacts via the External API.