REST API Reference

Our developer REST API allows you to send messages, manage contacts, and check conversation statuses programmatically.

---

1. Authentication

All requests to the AutomateIt API must be authenticated using a Bearer token. You can generate API Keys from the Settings → API Keys tab in your dashboard.

Include the token in your HTTP headers:

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

---

2. API Host URLs

• Production API: https://api.automateit.rockybits.com/v1
• Sandbox / Test API: https://sandbox.automateit.rockybits.com/v1

---

3. Endpoints Reference

Send a Text Message

Send a text message to a specific WhatsApp number.

• HTTP Method: POST
• Path: /messages
• Request Body:

{
  "to": "2348012345678",
  "type": "text",
  "text": {
    "body": "Hello from the AutomateIt API!"
  }
}

• Response (200 OK):

{
  "message_id": "msg_987654321_abc",
  "status": "queued",
  "to": "2348012345678"
}

Send a Template Message (Campaign / Transactional)

Initiate a template-based message outside the 24-hour window.

• HTTP Method: POST
• Path: /messages
• Request Body:

{
  "to": "2348012345678",
  "type": "template",
  "template": {
    "name": "order_delivery_update",
    "language": {
      "code": "en"
    },
    "components": [
      {
        "type": "body",
        "parameters": [
          { "type": "text", "text": "Chidi" },
          { "type": "text", "text": "#1095" }
        ]
      }
    ]
  }
}

Get Contact Details

Retrieve a single contact's info and active tags.

• HTTP Method: GET
• Path: /contacts/{phone_number}
• Response (200 OK):

{
  "phone": "2348012345678",
  "name": "Chidi Okoro",
  "tags": ["VIP Lead", "Unpaid"],
  "email": "chidi@example.com",
  "created_at": "2026-06-22T10:00:00Z"
}