API Documentation

Integrate Zuvo's SMS marketing capabilities into your applications with our comprehensive REST API

API Overview

Our RESTful API provides programmatic access to all Zuvo features

RESTful Design

Standard HTTP methods and JSON responses for easy integration.

Secure Authentication

API keys and OAuth 2.0 support for secure access control.

Real-time Updates

Webhooks and real-time notifications for instant updates.

Authentication

Secure your API requests with authentication headers

API Key Authentication

Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Getting Your API Key

  1. Log in to your Zuvo dashboard
  2. Navigate to Settings > API
  3. Generate a new API key
  4. Copy the key and keep it secure

API Endpoints

Complete reference of all available API endpoints

POST /api/v1/sms/send

Send a single SMS message to a phone number.

Request Body:

{
  "to": "+1234567890",
  "message": "Hello from Zuvo!",
  "from": "ZUVO"
}

Response:

{
  "success": true,
  "message_id": "msg_123456789",
  "status": "queued"
}
GET /api/v1/campaigns

Retrieve a list of all campaigns.

Response:

{
  "campaigns": [
    {
      "id": "camp_123",
      "name": "Welcome Campaign",
      "status": "active",
      "created_at": "2024-01-15T10:30:00Z"
    }
  ]
}
POST /api/v1/contacts

Add a new contact to your list.

Request Body:

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

SDKs & Libraries

Official SDKs for popular programming languages

JavaScript

Node.js and browser support

Python

pip install zuvo-sdk

PHP

Composer package

Ruby

Gem installation

Ready to Integrate?

Start building with our API today

Ready to convert? Let's get started View Documentation