Getting Started
API Reference
Resources

Health checkget

customers-routes

List customersget

Create or update a customerput

Create a customerpost

Get customer detailsget

Update a customerput

Delete a customerdelete

locations-routes

List business locationsget

Create a business locationpost

Get business location detailsget

Delete a business locationdelete

Update a business locationpatch

enquiries-routes

List enquiriesget

Get enquiry detailsget

messages-routes

Send a message to a customerput

Send a message on an existing enquiryput

Schedule a message to a customerput

Schedule a message on an existing enquiryput

Send a review requestput

Send a review request on an existing enquiryput

payments-routes

Create a payment requestpost

Check customer saved-card statuspost

powered by Zuplo

Coax API

index

Endpointhttps://api.coax.com.au

Service health and status checks.

Health check

GET

https://api.coax.com.au

/health

Lightweight unauthenticated health check used to confirm the app is running.

Health check › Responses

200

Application is running.

status

string · required

GET/health

curl --request GET \
  --url https://api.coax.com.au/health

shell

Example Responses

{
  "status": "UP"
}

json

application/json

customers-routes