ReferenceAPI Reference

API Reference

A complete reference of all available ChumiAI API endpoints. All endpoints require authentication via the X-API-Key header.

Base URL: https://api.chumiai.app

WhatsApp API

Endpoints for sending messages, managing templates, and monitoring bulk jobs.

Template Messaging

POST/api/v1/whatsapp/send-template
Send a template message to a single recipient
POST/api/v1/whatsapp/bulk-import-messages
Bulk send via Excel/CSV file upload (multipart/form-data)
POST/api/v1/whatsapp/send-template-to-group
Send a template to all contacts in a group

Templates

GET/api/v1/whatsapp/templates
List all approved message templates
POST/api/v1/whatsapp/templates/sync
Sync templates from Meta Business Suite

Bulk Jobs

GET/api/v1/whatsapp/bulk-jobs
List all bulk job history with pagination
GET/api/v1/whatsapp/bulk-jobs/{jobId}/status
Get status and progress of a specific bulk job

Contacts API

Endpoints for managing contacts and contact groups in ChumiAI.

Contacts

GET/api/v1/contacts
List all contacts with pagination and filtering
GET/api/v1/contacts/{id}
Get a single contact by ID
POST/api/v1/contacts
Create a new contact
PUT/api/v1/contacts/{id}
Update an existing contact's details
DELETE/api/v1/contacts/{id}
Delete a contact

Contact Groups

GET/api/v1/contacts/groups
List all contact groups
GET/api/v1/contacts/groups/{id}
Get a group with its contacts
POST/api/v1/contacts/groups
Create a new contact group
POST/api/v1/contacts/groups/{id}/members
Add contacts to a group
DELETE/api/v1/contacts/groups/{id}/members
Remove contacts from a group

Products API

Endpoints for managing product catalog data. Useful for syncing products from Shopify, WooCommerce, or custom e-commerce platforms.

GET/api/v1/products
List all products with pagination
GET/api/v1/products/{id}
Get a single product by ID
POST/api/v1/products
Create a new product
PUT/api/v1/products/{id}
Update an existing product
DELETE/api/v1/products/{id}
Delete a product
POST/api/v1/products/sync
Trigger a full catalog sync from your connected store

Conversations API

Endpoints for retrieving conversation and message history.

GET/api/v1/conversations
List all conversations with pagination
GET/api/v1/conversations/{id}
Get a conversation with full message history
GET/api/v1/conversations/{id}/messages
Get paginated messages for a conversation

Common Parameters

Pagination

Most list endpoints support pagination via query parameters:

| Parameter | Type | Default | Description | | :--- | :--- | :--- | :--- | | page | integer | 1 | Page number to retrieve | | pageSize | integer | 20 | Number of items per page (max 100) |

Standard Response Format

All list endpoints return data in this format:

Paginated Response
{
"data": [...],
"pagination": {
  "page": 1,
  "pageSize": 20,
  "totalItems": 156,
  "totalPages": 8
}
}

Error Response Format

Error Response
{
"error": "Error Type",
"message": "Human-readable description of what went wrong.",
"statusCode": 400
}

| Status Code | Meaning | | :--- | :--- | | 200 | Success | | 201 | Created | | 400 | Bad Request — invalid parameters | | 401 | Unauthorized — missing or invalid API key | | 403 | Forbidden — insufficient scopes | | 404 | Not Found — resource doesn't exist | | 429 | Too Many Requests — rate limit exceeded | | 500 | Internal Server Error |

Detailed Endpoint Docs

For detailed request/response schemas for specific endpoints, see the individual feature guides (e.g., Send Template Message).