locations-routes

Endpointhttps://api.coax.com.au

Manage the business locations under your account.

List business locations

GET

https://api.coax.com.au

/api/v2/business/locations

Returns all locations for the selected business.

List business locations › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

List business locations › Responses

200

Locations fetched successfully. Response message: Fetched locations!.

success

boolean · required

message

string · required

object[] · required

Create a business location

POST

https://api.coax.com.au

/api/v2/business/locations

Creates a new business location. The route expects at least the location name, address, and working hours, and can optionally purchase a number when combined with the required forwarding details.

Create a business location › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Create a business location › Request Body

name

string · required

address

string · required

object[] · required

timezone

string

google_place_id

string

call_forwarding_number

string

purchase_number

boolean

Create a business location › Responses

Location created successfully. Response message: Business location created!.

success

boolean · required

message

string · required

object · required

POST/api/v2/business/locations

curl --request POST \
  --url https://api.coax.com.au/api/v2/business/locations \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Sydney Showroom",
  "address": "100 George St, Sydney NSW 2000",
  "timezone": "Australia/Sydney",
  "google_place_id": "ChIJN1t_tDeuEmsRUsoyG83frY4",
  "call_forwarding_number": "+61412345678",
  "purchase_number": true,
  "working_hours": [
    {
      "day": "Monday",
      "start": "09:00",
      "end": "17:00",
      "status": "open"
    }
  ]
}
'

shell

Example Request Body

{
  "name": "Sydney Showroom",
  "address": "100 George St, Sydney NSW 2000",
  "timezone": "Australia/Sydney",
  "google_place_id": "ChIJN1t_tDeuEmsRUsoyG83frY4",
  "call_forwarding_number": "+61412345678",
  "purchase_number": true,
  "working_hours": [
    {
      "day": "Monday",
      "start": "09:00",
      "end": "17:00",
      "status": "open"
    }
  ]
}

json

application/json

Example Responses

{
  "success": true,
  "message": "Business location created!",
  "body": {
    "id": "3b4d14fd-4c63-49d2-a2a9-d4f7befc3a14",
    "name": "Sydney Showroom",
    "address": "100 George St, Sydney NSW 2000",
    "google_location_id": "ChIJN1t_tDeuEmsRUsoyG83frY4"
  }
}

json

application/json

Get business location details

GET

https://api.coax.com.au

/api/v2/business/locations/{id}

Returns the selected business location.

Get business location details › path Parameters

id

string · uuid · required

Business location UUID.

Get business location details › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get business location details › Responses

Location fetched successfully. Response message: Location fetched!.

success

boolean · required

message

string · required

object · required

Delete a business location

DELETE

https://api.coax.com.au

/api/v2/business/locations/{id}

Deletes the selected business location when the business still has at least one remaining location and the billing rules allow deletion.

Delete a business location › path Parameters

id

string · uuid · required

Business location UUID.

Delete a business location › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Delete a business location › Responses

Location deleted successfully. Response message: Location deleted!.

success

boolean · required

message

string · required

body

object · required

Update a business location

PATCH

https://api.coax.com.au

/api/v2/business/locations/{id}

Updates the selected location's details.

Update a business location › path Parameters

id

string · uuid · required

Business location UUID.

Update a business location › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Update a business location › Request Body

name

string

address

string

timezone

string

object[]

ivr_link

string

Public URL for the IVR menu prompt audio. When updated, the Twilio Studio flow is refreshed to pick up the new audio.

Update a business location › Responses

Location updated successfully. Response message: Business location updated!.

success

boolean · required

message

string · required

body

object · required

PATCH/api/v2/business/locations/{id}

curl --request PATCH \
  --url https://api.coax.com.au/api/v2/business/locations/:id \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Sydney Showroom",
  "address": "110 George St, Sydney NSW 2000",
  "timezone": "Australia/Sydney",
  "ivr_link": "https://assets.coaxspaces.com/ivr/public/locations/loc_123/ivr_menu.mp3"
}
'

shell

Example Request Body

{
  "name": "Sydney Showroom",
  "address": "110 George St, Sydney NSW 2000",
  "timezone": "Australia/Sydney",
  "ivr_link": "https://assets.coaxspaces.com/ivr/public/locations/loc_123/ivr_menu.mp3"
}

json

application/json

Example Responses

{
  "success": true,
  "message": "Business location updated!",
  "body": {}
}

json

application/json

customers-routes enquiries-routes

List business locations

GET

https://api.coax.com.au

/api/v2/business/locations

Returns all locations for the selected business.

List business locations › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

List business locations › Responses

200

Locations fetched successfully. Response message: Fetched locations!.

success

boolean · required

message

string · required

object[] · required

Create a business location

POST

https://api.coax.com.au

/api/v2/business/locations

Creates a new business location. The route expects at least the location name, address, and working hours, and can optionally purchase a number when combined with the required forwarding details.

Create a business location › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Create a business location › Request Body

name

string · required

address

string · required

object[] · required

timezone

string

google_place_id

string

call_forwarding_number

string

purchase_number

boolean

Create a business location › Responses

Location created successfully. Response message: Business location created!.

success

boolean · required

message

string · required

object · required

Get business location details

GET

https://api.coax.com.au

/api/v2/business/locations/{id}

Returns the selected business location.

Get business location details › path Parameters

id

string · uuid · required

Business location UUID.

Get business location details › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get business location details › Responses

Location fetched successfully. Response message: Location fetched!.

success

boolean · required

message

string · required

object · required

Delete a business location

DELETE

https://api.coax.com.au

/api/v2/business/locations/{id}

Deletes the selected business location when the business still has at least one remaining location and the billing rules allow deletion.

Delete a business location › path Parameters

id

string · uuid · required

Business location UUID.

Delete a business location › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Delete a business location › Responses

Location deleted successfully. Response message: Location deleted!.

success

boolean · required

message

string · required

body

object · required

Update a business location

PATCH

https://api.coax.com.au

/api/v2/business/locations/{id}

Updates the selected location's details.

Update a business location › path Parameters

id

string · uuid · required

Business location UUID.

Update a business location › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Update a business location › Request Body

name

string

address

string

timezone

string

object[]

ivr_link

string

Public URL for the IVR menu prompt audio. When updated, the Twilio Studio flow is refreshed to pick up the new audio.

Update a business location › Responses

Location updated successfully. Response message: Business location updated!.

success

boolean · required

message

string · required

body

object · required