Copy page

Coax API

Welcome to the Coax developer documentation. The Coax API lets you manage customers, business locations, enquiries, and messaging from your own apps and backend services.

Base URL

All requests go to the Coax API:

Code
https://api.coax.com.au

Authentication

Every endpoint (except GET /health) requires a Coax-issued API key sent as a bearer token:

Code
Authorization: Bearer <your-api-key>

To get an API key, please contact your Coax representative or email [email protected]. Keys are issued per business and can be rotated at any time on request.

Response shape

Coax endpoints return a consistent envelope:

Code
{
  "success": true,
  "message": "Customers fetched!",
  "body": { "data": [], "current_page": 1 }
}

On failure, success is false, message is human-readable, and body (when present) carries extra detail.

What you can do

• Customers — list, look up, create, update, and delete customer records.
• Locations — manage the business locations under your account and look up the business_location_id you need when sending messages.
• Enquiries — list customer enquiries and inspect a single enquiry by id.
• Messages — send a message, schedule a follow-up, and request a Google review. Each of these has two flavours:
  • You don't have an enquiry id (the common case) — use the PUT /api/v2/message/send/{channel}, PUT /api/v2/message/schedule/{channel}, and PUT /api/v2/message/ask-for-review endpoints. Pass the customer's phone or email and a business_location_id; Coax finds or creates the customer and enquiry for you before sending.
  • You already have an enquiry id (e.g. you fetched it from GET /api/v2/message/enquiries) — use the corresponding …/{enquiry_id}/… variant.
• Health — GET /health for service status.

See the API Reference for the full request and response schemas.

Quick start: send a message to a customer

You don't need to know an enquiry id. Just provide the customer's phone (or email) and a business_location_id:

Code
curl -X PUT https://api.coax.com.au/api/v2/message/send/sms \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Jordan Lee",
    "phone": "+61412345678",
    "business_location_id": "3b4d14fd-4c63-49d2-a2a9-d4f7befc3a14",
    "message": "Hi Jordan, just following up on your enquiry."
  }'

A successful response returns the enquiry that was used or created so you can keep using it on follow-up calls:

Code
{
  "success": true,
  "message": "Message sent!",
  "body": { "enquiry_id": "c74f0f51-67d5-4aea-b3a4-e7aa68486dbd" }
}

Finding your business_location_id

List the locations on your account:

Code
curl https://api.coax.com.au/api/v2/business/locations \
  -H "Authorization: Bearer YOUR_API_KEY"

Use the id of the location you want to send from as business_location_id on subsequent calls.

Need help?

Email [email protected] and we'll get back to you.