customers-routes

Endpointhttps://api.coax.com.au

Manage customer records on a business location.

List customers

GET

https://api.coax.com.au

/api/v2/business/customers

Returns paginated customers for the current business and location context.

List customers › query Parameters

page

integer

page_size

integer

q

string

List customers › 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 customers › Responses

Customers fetched successfully. Response message: Customers fetched!.

success

boolean · required

message

string · required

object · required

Create or update a customer

PUT

https://api.coax.com.au

/api/v2/business/customers

Finds or creates a customer by the supplied contact details and updates the record when needed.

Create or update a customer › 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 or update a customer › Request Body

name

string

address

string

email

string · email

phone

string

avatar

string

company_name

string

added_tags

string[]

tags

string[]

source

string

do_not_update

boolean

location_id

string · uuid

Create or update a customer › Responses

Customer upserted successfully. Response message: Customer upserted!.

success

boolean · required

message

string · required

object · required

PUT/api/v2/business/customers

curl --request PUT \
  --url https://api.coax.com.au/api/v2/business/customers \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Jordan Lee",
  "address": "5 High St, Sydney NSW 2000",
  "email": "[email protected]",
  "phone": "+61412345678",
  "company_name": "Lee Electrical",
  "added_tags": [
    "vip"
  ],
  "source": "Import",
  "do_not_update": false,
  "location_id": "3b4d14fd-4c63-49d2-a2a9-d4f7befc3a14"
}
'

shell

Example Request Body

{
  "name": "Jordan Lee",
  "address": "5 High St, Sydney NSW 2000",
  "email": "[email protected]",
  "phone": "+61412345678",
  "company_name": "Lee Electrical",
  "added_tags": [
    "vip"
  ],
  "source": "Import",
  "do_not_update": false,
  "location_id": "3b4d14fd-4c63-49d2-a2a9-d4f7befc3a14"
}

json

application/json

Example Responses

{
  "success": true,
  "message": "Customer upserted!",
  "body": {
    "id": "47e8d45d-16d3-4bed-a4a5-266331749aaa",
    "name": "Jordan Lee",
    "company_name": "Lee Electrical",
    "address": "5 High St, Sydney NSW 2000",
    "tags": [
      "vip"
    ],
    "source": "Import",
    "status": "active"
  }
}

json

application/json

Create a customer

POST

https://api.coax.com.au

/api/v2/business/customers

Creates a customer in the currently selected business and location.

Create a customer › 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 customer › Request Body

name

string

address

string

company_name

string

source

string

status

string

location_id

string · uuid

object[]

tags

string[]

Create a customer › Responses

Customer created successfully. Response message: Customer created!.

success

boolean · required

message

string · required

object · required

POST/api/v2/business/customers

curl --request POST \
  --url https://api.coax.com.au/api/v2/business/customers \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Jordan Lee",
  "address": "5 High St, Sydney NSW 2000",
  "company_name": "Lee Electrical",
  "source": "Website",
  "status": "active",
  "location_id": "3b4d14fd-4c63-49d2-a2a9-d4f7befc3a14",
  "phones": [
    {
      "code": "+61",
      "value": "412345678",
      "primary": true
    }
  ],
  "emails": [
    {
      "value": "[email protected]",
      "primary": true
    }
  ],
  "tags": [
    "vip"
  ]
}
'

shell

Example Request Body

{
  "name": "Jordan Lee",
  "address": "5 High St, Sydney NSW 2000",
  "company_name": "Lee Electrical",
  "source": "Website",
  "status": "active",
  "location_id": "3b4d14fd-4c63-49d2-a2a9-d4f7befc3a14",
  "phones": [
    {
      "code": "+61",
      "value": "412345678",
      "primary": true
    }
  ],
  "emails": [
    {
      "value": "[email protected]",
      "primary": true
    }
  ],
  "tags": [
    "vip"
  ]
}

json

application/json

Example Responses

{
  "success": true,
  "message": "Customer created!",
  "body": {
    "id": "47e8d45d-16d3-4bed-a4a5-266331749aaa",
    "name": "Jordan Lee",
    "company_name": "Lee Electrical",
    "address": "5 High St, Sydney NSW 2000",
    "tags": [
      "vip"
    ],
    "source": "Website",
    "status": "active"
  }
}

json

application/json

Get customer details

GET

https://api.coax.com.au

/api/v2/business/customers/{id}

Returns the full customer record for the selected customer UUID.

Get customer details › path Parameters

id

string · uuid · required

Customer UUID.

Get customer 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 customer details › Responses

Customer fetched successfully. Response message: Customer fetched!.

success

boolean · required

message

string · required

object · required

Update a customer

PUT

https://api.coax.com.au

/api/v2/business/customers/{id}

Updates a customer record, including contacts, tags, company details, and source metadata.

Update a customer › path Parameters

id

string · uuid · required

Customer UUID.

Update a customer › 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 customer › Request Body

name

string

address

string

company_name

string

object[]

tags

string[]

Update a customer › Responses

Customer updated successfully.

success

boolean · required

message

string · required

body

object · required

PUT/api/v2/business/customers/{id}

curl --request PUT \
  --url https://api.coax.com.au/api/v2/business/customers/:id \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Jordan Lee",
  "address": "10 New Address Rd, Sydney NSW 2000",
  "company_name": "Lee Electrical",
  "phones": [
    {
      "code": "+61",
      "value": "419998888",
      "primary": true
    }
  ],
  "emails": [
    {
      "value": "[email protected]",
      "primary": true
    }
  ],
  "tags": [
    "vip",
    "quote_pending"
  ]
}
'

shell

Example Request Body

{
  "name": "Jordan Lee",
  "address": "10 New Address Rd, Sydney NSW 2000",
  "company_name": "Lee Electrical",
  "phones": [
    {
      "code": "+61",
      "value": "419998888",
      "primary": true
    }
  ],
  "emails": [
    {
      "value": "[email protected]",
      "primary": true
    }
  ],
  "tags": [
    "vip",
    "quote_pending"
  ]
}

json

application/json

Example Responses

{
  "success": true,
  "message": "Customer updated!",
  "body": {}
}

json

application/json

Delete a customer

DELETE

https://api.coax.com.au

/api/v2/business/customers/{id}

Deletes the selected customer record when the underlying customer delete rules allow it.

Delete a customer › path Parameters

id

string · uuid · required

Customer UUID.

Delete a customer › 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 customer › Responses

Customer deleted successfully.

success

boolean · required

message

string · required

body

object · required

index locations-routes

List customers

GET

https://api.coax.com.au

/api/v2/business/customers

Returns paginated customers for the current business and location context.

List customers › query Parameters

page

integer

page_size

integer

q

string

List customers › 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 customers › Responses

Customers fetched successfully. Response message: Customers fetched!.

success

boolean · required

message

string · required

object · required

Create or update a customer

PUT

https://api.coax.com.au

/api/v2/business/customers

Finds or creates a customer by the supplied contact details and updates the record when needed.

Create or update a customer › 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 or update a customer › Request Body

name

string

address

string

email

string · email

phone

string

avatar

string

company_name

string

added_tags

string[]

tags

string[]

source

string

do_not_update

boolean

location_id

string · uuid

Create or update a customer › Responses

Customer upserted successfully. Response message: Customer upserted!.

success

boolean · required

message

string · required

object · required

Create a customer

POST

https://api.coax.com.au

/api/v2/business/customers

Creates a customer in the currently selected business and location.

Create a customer › 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 customer › Request Body

name

string

address

string

company_name

string

source

string

status

string

location_id

string · uuid

object[]

tags

string[]

Create a customer › Responses

Customer created successfully. Response message: Customer created!.

success

boolean · required

message

string · required

object · required

Get customer details

GET

https://api.coax.com.au

/api/v2/business/customers/{id}

Returns the full customer record for the selected customer UUID.

Get customer details › path Parameters

id

string · uuid · required

Customer UUID.

Get customer 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 customer details › Responses

Customer fetched successfully. Response message: Customer fetched!.

success

boolean · required

message

string · required

object · required

Update a customer

PUT

https://api.coax.com.au

/api/v2/business/customers/{id}

Updates a customer record, including contacts, tags, company details, and source metadata.

Update a customer › path Parameters

id

string · uuid · required

Customer UUID.

Update a customer › 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 customer › Request Body

name

string

address

string

company_name

string

object[]

tags

string[]

Update a customer › Responses

Customer updated successfully.

success

boolean · required

message

string · required

body

object · required

Delete a customer

DELETE

https://api.coax.com.au

/api/v2/business/customers/{id}

Deletes the selected customer record when the underlying customer delete rules allow it.

Delete a customer › path Parameters

id

string · uuid · required

Customer UUID.

Delete a customer › 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 customer › Responses

Customer deleted successfully.

success

boolean · required

message

string · required

body

object · required