REST API Basics

REST API Basics

Learn how to connect your applications, automate workflows, and exchange data seamlessly using our REST API.

What is the REST API?

The REST API allows external applications to interact with your chatbot automation platform programmatically. Using API endpoints, you can manage contacts, send messages, trigger automations, retrieve conversation data, and integrate with third-party systems.

Getting Started

Before making API requests, you'll need:

• An active account

• API credentials

• API access enabled on your workspace

Authentication

All API requests must include your API key in the request header.

Required Header

Authorization: Bearer YOUR_API_KEYContent-Type: application/json

Authorization: Bearer YOUR_API_KEYContent-Type: application/json

Authorization: Bearer YOUR_API_KEYContent-Type: application/json

Base URL

https://api.yourdomain.com/v1

https://api.yourdomain.com/v1

https://api.yourdomain.com/v1

Common API Operations

Send a Message

POST /messages/send

POST /messages/send

POST /messages/send

{  "recipient": "+1234567890",  "message": "Hello! Welcome to our service."}

{  "recipient": "+1234567890",  "message": "Hello! Welcome to our service."}

{  "recipient": "+1234567890",  "message": "Hello! Welcome to our service."}

Get Contact Information

GET /contacts/{contact_id}

GET /contacts/{contact_id}

GET /contacts/{contact_id}

Create a Contact

POST /contacts

POST /contacts

POST /contacts

{  "name": "John Doe",  "phone": "+1234567890",  "email": "john@example.com"}

{  "name": "John Doe",  "phone": "+1234567890",  "email": "john@example.com"}

{  "name": "John Doe",  "phone": "+1234567890",  "email": "john@example.com"}

Response Format

Successful requests return:

{  "success": true,  "data": {}}

{  "success": true,  "data": {}}

{  "success": true,  "data": {}}

Error responses return:

{  "success": false,  "message": "Invalid API key"}

{  "success": false,  "message": "Invalid API key"}

{  "success": false,  "message": "Invalid API key"}

Rate Limits

To ensure platform stability, API requests are subject to rate limits.

• Standard Plan: 100 requests/minute

• Professional Plan: 500 requests/minute

• Enterprise Plan: Custom limits

Best Practices

• Store API keys securely

• Use HTTPS for all requests

• Implement retry mechanisms

• Monitor API usage regularly

• Validate data before sending requests