ChatofyDevelopersv1.0
API KeysWebhooks
REST API Documentation
/
Getting Started
API Resources
API v1.0 Live
99.99%
Developer Platform/REST API v1/Overview & Guides

Chatofy Developer API

Build automated WhatsApp-first workflows, send outbound campaign broadcasts, and integrate your CRM with programmatic HTTP endpoints.

Quick Start Guide

Recommended

Send your first WhatsApp message via cURL in under 60 seconds.

Authentication & Keys

Bearer token authorization headers and API key security practices.

Endpoint Reference

Detailed schemas for messages, contacts, campaigns, and tags.

Webhook Subscriptions

Real-time

Receive real-time HTTP POST notifications on incoming WhatsApp messages.

1. Platform Introduction

The Chatofy Developer REST API enables programmatic access to your WhatsApp Business ecosystem. Instead of manually navigating CRM dashboards, your external servers, webhooks, or third-party platforms (like Zapier, Make, and backend microservices) can dispatch messages and manage leads.

Common API Workflows

Send plain text or media WhatsApp messages
Trigger pre-approved Meta message templates
Synchronize lead attributes, custom tags, and notes
Broadcast automated mass message campaigns
Audience: Software engineers and system integrators. All API responses use standard HTTP status codes and JSON envelopes.

2. Base URL & Encoding

All API requests are sent over HTTPS to the canonical production gateway. All payload bodies and responses use UTF-8 JSON encoding.

Production Base URLhttps://app.chatofy.in/api/v1
Content-Type: application/json

3. Bearer Token Authentication

Every request must provide your secret API key in the standard HTTP Authorization header using the Bearer scheme.

cURL Authentication Example
curl -X GET "https://app.chatofy.in/api/v1/contacts" \
  -H "Authorization: Bearer cfy_sk_live_yourSecretKey" \
  -H "Content-Type: application/json"
Protect your secret tokens: Never include API keys in client-side frontends or public source control repositories. Treat your key as you would a database password.

4. API Key Lifecycle & Quotas

Organizations can provision and revoke secret keys directly in their workspace settings. Each key inherits permissions scoped to your organization.

Generation & Rolling

Generate fresh tokens with custom identifiers. When rolling credentials, revoke your existing key to provision a replacement.

Encrypted Storage

Tokens are encrypted at rest with AES-256-GCM. SHA-256 hashes are used for instant constant-time lookup.

Go to API Key Management

5. Rate Limits & Throttling

To guarantee high availability and protect WhatsApp Cloud API upstream thresholds, requests are throttled per organization token:

Plan TierRequests / MinuteBurst AllowanceStatus
Standard Plan100 req / min200 requestsActive
Professional Plan500 req / min1,000 requestsRecommended
Enterprise / Agency2,000 req / min5,000 requestsDedicated

When limits are exceeded, the API returns a 429 Too Many Requests response. Inspect the standard Retry-After response header for backoff recommendations.


6. Error Response Schema

Chatofy returns standard HTTP status codes with a predictable JSON envelope indicating error details:

HTTP CodeError CodeDescription & Remediation
200 / 201SUCCESSOperation completed as requested.
400BAD_REQUESTMissing or invalid payload fields or parameters.
401UNAUTHORIZEDMissing or invalid Bearer authentication token.
403FORBIDDENInsufficient permissions or feature not allowed on your plan.
429RATE_LIMIT_EXCEEDEDToo many requests dispatched within the minute window.
500INTERNAL_SERVER_ERRORUnexpected platform error. Retry with exponential backoff.

7. Quick Start: Dispatch a Message in 60s

Run this cURL snippet in your terminal to dispatch a live WhatsApp message:

1. Send Text Message via cURL
curl -X POST "https://app.chatofy.in/api/v1/contact/919876543210/send-message" \
  -H "Authorization: Bearer YOUR_SECRET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "text": {
      "body": "Hello from Chatofy API! 🚀",
      "preview_url": false
    }
  }'
Try without code: You can execute and verify live API requests directly inside your browser playground at Settings → API Keys.

8. All Endpoints Reference

Explore full request and response specifications for each resource endpoint:

Getting Started

Account & Profile

GET/api/v1/account
Get Account Details

Contacts

GET/api/v1/contacts
List Contacts
POST/api/v1/contact/create
Create Contact
POST/api/v1/contact/update/:phone
Update Contact

Messages

POST/api/v1/contact/:phone/send-message
Send Text Message
POST/api/v1/contact/:phone/send-interactive-message
Send Interactive Message
POST/api/v1/contact/:phone/send-media-message
Send Media Message
POST/api/v1/contact/:phone/send-media-message
Send Document
POST/api/v1/contact/:phone/send-template-message
Send Template Message

Templates

GET/api/v1/templates
List Templates

Campaigns

GET/api/v1/campaigns
List Campaigns
GET/api/v1/campaign/:id
Get Campaign
GET/api/v1/campaign/:id/logs
Campaign Logs

© 2026 Chatofy. All rights reserved.

•Privacy Policy•Terms of Service
Powered byChatofy Cloud Architecture

On this page

  • Introduction
  • Base URL & Encodings
  • Bearer Authentication
  • Key Provisioning
  • Rate Limiting Limits
  • Standard Error Codes
  • Quick Start Tutorial
  • All API Endpoints
Live Interactive Tester

Test and run WhatsApp API calls directly in the sandbox playground.

Launch API Sandbox