messages-routes

Endpointhttps://api.coax.com.au

Send messages, schedule follow-ups, and request reviews on an enquiry.

Send a message to a customer

PUT

https://api.coax.com.au

/api/v2/message/send/{channel}

Sends a message to a customer over the chosen channel. If the customer or enquiry does not exist yet, Coax will create them from the supplied phone/email/name before sending. Use this when you want to start or continue a conversation without first looking up an enquiry id.

Send a message to a customer › path Parameters

channel

string · required

Send a message to 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.

Send a message to a customer › Request Body

message

string

type

string

sub_type

string

attachment_ids

string[]

contact_id

string · uuid

contact_ids

string[]

team_user_id

string · uuid

business_location_id

string · uuid

location_id

string · uuid

createActivity

boolean

activity_type

string

activity_description

string

is_bot

boolean

enquiry_id

string · uuid

enquiry_status

string

campaign_id

string · uuid

name

string

email

string · email

phone

string

avatar

string

company_name

string

address

string

do_not_update

boolean

suppress_socket_events

boolean

Send a message to a customer › Responses

Message sent successfully. When campaign_id belongs to a paused campaign, the live route returns success: true with message Campaign is paused, message not sent. and no body.

success

boolean · required

message

string · required

object · required

PUT/api/v2/message/send/{channel}

curl --request PUT \
  --url https://api.coax.com.au/api/v2/message/send/:channel \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Jordan Lee",
  "email": "[email protected]",
  "phone": "+61412345678",
  "business_location_id": "3b4d14fd-4c63-49d2-a2a9-d4f7befc3a14",
  "message": "Thanks for getting in touch. We can help with that.",
  "type": "message",
  "sub_type": "outgoing"
}
'

shell

Example Request Body

{
  "name": "Jordan Lee",
  "email": "[email protected]",
  "phone": "+61412345678",
  "business_location_id": "3b4d14fd-4c63-49d2-a2a9-d4f7befc3a14",
  "message": "Thanks for getting in touch. We can help with that.",
  "type": "message",
  "sub_type": "outgoing"
}

json

application/json

Example Responses

{
  "success": true,
  "message": "Message sent!",
  "body": {
    "id": "a5b3fef8-b087-4bbf-9f7d-9a926f97f8d6",
    "enquiry_id": "c74f0f51-67d5-4aea-b3a4-e7aa68486dbd",
    "type": "message",
    "sub_type": "outgoing",
    "channel": "sms",
    "message": "Thanks for getting in touch. We can help with that.",
    "status": "sent"
  }
}

json

application/json

Send a message on an existing enquiry

PUT

https://api.coax.com.au

/api/v2/message/{enquiry_id}/send/{channel}

Sends a message on a known enquiry over the chosen channel. Use this when you already have an enquiry_id. If you only have a customer's phone/email, prefer PUT /api/v2/message/send/{channel}.

Send a message on an existing enquiry › path Parameters

enquiry_id

string · uuid · required

channel

string · required

Send a message on an existing enquiry › 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.

Send a message on an existing enquiry › Request Body

message

string

type

string

sub_type

string

attachment_ids

string[]

contact_id

string · uuid

contact_ids

string[]

team_user_id

string · uuid

business_location_id

string · uuid

location_id

string · uuid

createActivity

boolean

activity_type

string

activity_description

string

is_bot

boolean

Send a message on an existing enquiry › Responses

Store a received message completed successfully.

success

boolean · required

message

string · required

object · required

PUT/api/v2/message/{enquiry_id}/send/{channel}

curl --request PUT \
  --url https://api.coax.com.au/api/v2/message/:enquiry_id/send/:channel \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "message": "Hi, I just sent through my details.",
  "type": "message",
  "sub_type": "incoming",
  "business_location_id": "3b4d14fd-4c63-49d2-a2a9-d4f7befc3a14"
}
'

shell

Example Request Body

{
  "message": "Hi, I just sent through my details.",
  "type": "message",
  "sub_type": "incoming",
  "business_location_id": "3b4d14fd-4c63-49d2-a2a9-d4f7befc3a14"
}

json

application/json

Example Responses

{
  "success": true,
  "message": "Message received!",
  "body": {
    "id": "a5b3fef8-b087-4bbf-9f7d-9a926f97f8d6",
    "enquiry_id": "c74f0f51-67d5-4aea-b3a4-e7aa68486dbd",
    "type": "message",
    "sub_type": "incoming",
    "channel": "facebook",
    "message": "Hi, I just sent through my details.",
    "status": "received"
  }
}

json

application/json

Schedule a message to a customer

PUT

https://api.coax.com.au

/api/v2/message/schedule/{channel}

Schedules a message to be delivered later. Coax finds or creates the customer and enquiry from the supplied details before scheduling.

Schedule a message to a customer › path Parameters

channel

string · required

Schedule a message to 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.

Schedule a message to a customer › Request Body

message

string

type

string

sub_type

string

attachment_ids

string[]

contact_id

string · uuid

contact_ids

string[]

team_user_id

string · uuid

business_location_id

string · uuid

location_id

string · uuid

createActivity

boolean

activity_type

string

activity_description

string

is_bot

boolean

enquiry_id

string · uuid

enquiry_status

string

campaign_id

string · uuid

name

string

email

string · email

phone

string

avatar

string

company_name

string

address

string

do_not_update

boolean

suppress_socket_events

boolean

scheduled_at

string · date-time

customer_id

string · uuid

Schedule a message to a customer › Responses

Schedule a message without an enquiry ID completed successfully.

success

boolean · required

message

string · required

object · required

PUT/api/v2/message/schedule/{channel}

curl --request PUT \
  --url https://api.coax.com.au/api/v2/message/schedule/:channel \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Jordan Lee",
  "email": "[email protected]",
  "phone": "+61412345678",
  "business_location_id": "3b4d14fd-4c63-49d2-a2a9-d4f7befc3a14",
  "message": "Checking in on your quote request.",
  "scheduled_at": "2026-03-28T10:30:00.000Z"
}
'

shell

Example Request Body

{
  "name": "Jordan Lee",
  "email": "[email protected]",
  "phone": "+61412345678",
  "business_location_id": "3b4d14fd-4c63-49d2-a2a9-d4f7befc3a14",
  "message": "Checking in on your quote request.",
  "scheduled_at": "2026-03-28T10:30:00.000Z"
}

json

application/json

Example Responses

{
  "success": true,
  "message": "Message scheduled!",
  "body": {
    "id": "a5b3fef8-b087-4bbf-9f7d-9a926f97f8d6",
    "enquiry_id": "c74f0f51-67d5-4aea-b3a4-e7aa68486dbd",
    "type": "message",
    "channel": "sms",
    "message": "Checking in on your quote request.",
    "scheduled_at": "2026-03-28T10:30:00.000Z"
  }
}

json

application/json

Schedule a message on an existing enquiry

PUT

https://api.coax.com.au

/api/v2/message/{enquiry_id}/schedule/{channel}

Schedules a message on a known enquiry. Use this when you already have an enquiry_id; otherwise use PUT /api/v2/message/schedule/{channel}.

Schedule a message on an existing enquiry › path Parameters

enquiry_id

string · uuid · required

channel

string · required

Schedule a message on an existing enquiry › 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.

Schedule a message on an existing enquiry › Request Body

message

string

type

string

sub_type

string

attachment_ids

string[]

contact_id

string · uuid

contact_ids

string[]

team_user_id

string · uuid

business_location_id

string · uuid

location_id

string · uuid

createActivity

boolean

activity_type

string

activity_description

string

is_bot

boolean

scheduled_at

string · date-time

Schedule a message on an existing enquiry › Responses

Schedule a message completed successfully.

success

boolean · required

message

string · required

object · required

PUT/api/v2/message/{enquiry_id}/schedule/{channel}

curl --request PUT \
  --url https://api.coax.com.au/api/v2/message/:enquiry_id/schedule/:channel \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "message": "Checking in on your quote request.",
  "scheduled_at": "2026-03-28T10:30:00.000Z",
  "attachment_ids": [
    "f55ae208-536f-425a-9bc7-5f5749ac8914"
  ],
  "business_location_id": "3b4d14fd-4c63-49d2-a2a9-d4f7befc3a14"
}
'

shell

Example Request Body

{
  "message": "Checking in on your quote request.",
  "scheduled_at": "2026-03-28T10:30:00.000Z",
  "attachment_ids": [
    "f55ae208-536f-425a-9bc7-5f5749ac8914"
  ],
  "business_location_id": "3b4d14fd-4c63-49d2-a2a9-d4f7befc3a14"
}

json

application/json

Example Responses

{
  "success": true,
  "message": "Message scheduled!",
  "body": {
    "id": "a5b3fef8-b087-4bbf-9f7d-9a926f97f8d6",
    "enquiry_id": "c74f0f51-67d5-4aea-b3a4-e7aa68486dbd",
    "type": "message",
    "channel": "sms",
    "message": "Checking in on your quote request.",
    "scheduled_at": "2026-03-28T10:30:00.000Z"
  }
}

json

application/json

Send a review request

PUT

https://api.coax.com.au

/api/v2/message/ask-for-review

Sends a review request to a customer. If the customer or enquiry does not exist yet, Coax will create them from the supplied details first. This is the simplest way to ask a customer for a review.

Send a review request › 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.

Send a review request › Request Body

channel

string

message

string

review_types

string

business_location_id

string · uuid

location_id

string · uuid

createActivity

boolean

activity_type

string

activity_description

string

object

enquiry_id

string · uuid

email

string · email

phone

string

name

string

company_name

string

address

string

avatar

string

do_not_update

boolean

object[]

customer_id

string · uuid

Send a review request › Responses

Review request sent successfully. Response message: Sent review request!.

success

boolean · required

message

string · required

object · required

PUT/api/v2/message/ask-for-review

curl --request PUT \
  --url https://api.coax.com.au/api/v2/message/ask-for-review \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Jordan Lee",
  "email": "[email protected]",
  "phone": "+61412345678",
  "business_location_id": "3b4d14fd-4c63-49d2-a2a9-d4f7befc3a14",
  "channel": "sms",
  "review_types": "google",
  "message": "Thanks for choosing us. Would you mind leaving a review? {{ review_link }}"
}
'

shell

Example Request Body

{
  "name": "Jordan Lee",
  "email": "[email protected]",
  "phone": "+61412345678",
  "business_location_id": "3b4d14fd-4c63-49d2-a2a9-d4f7befc3a14",
  "channel": "sms",
  "review_types": "google",
  "message": "Thanks for choosing us. Would you mind leaving a review? {{ review_link }}"
}

json

application/json

Example Responses

{
  "success": true,
  "message": "Sent review request!",
  "body": {
    "enquiry_id": "c74f0f51-67d5-4aea-b3a4-e7aa68486dbd"
  }
}

json

application/json

Send a review request on an existing enquiry

PUT

https://api.coax.com.au

/api/v2/message/{enquiry_id}/ask-for-review

Sends a review request against a known enquiry. Use this when you already have an enquiry_id; otherwise use PUT /api/v2/message/ask-for-review.

Send a review request on an existing enquiry › path Parameters

enquiry_id

string · uuid · required

Send a review request on an existing enquiry › 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.

Send a review request on an existing enquiry › Request Body

channel

string

message

string

review_types

string

business_location_id

string · uuid

location_id

string · uuid

createActivity

boolean

activity_type

string

activity_description

string

object

Send a review request on an existing enquiry › Responses

Review request sent successfully. Response message: Sent review request!.

success

boolean · required

message

string · required

object · required

PUT/api/v2/message/{enquiry_id}/ask-for-review

curl --request PUT \
  --url https://api.coax.com.au/api/v2/message/:enquiry_id/ask-for-review \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "channel": "sms",
  "review_types": "google",
  "business_location_id": "3b4d14fd-4c63-49d2-a2a9-d4f7befc3a14",
  "message": "Thanks for choosing us. Would you mind leaving a review? {{ review_link }}"
}
'

shell

Example Request Body

{
  "channel": "sms",
  "review_types": "google",
  "business_location_id": "3b4d14fd-4c63-49d2-a2a9-d4f7befc3a14",
  "message": "Thanks for choosing us. Would you mind leaving a review? {{ review_link }}"
}

json

application/json

Example Responses

{
  "success": true,
  "message": "Sent review request!",
  "body": {
    "enquiry_id": "c74f0f51-67d5-4aea-b3a4-e7aa68486dbd"
  }
}

json

application/json

enquiries-routes

Send a message to a customer

PUT

https://api.coax.com.au

/api/v2/message/send/{channel}

Send a message to a customer › path Parameters

channel

string · required

Send a message to 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.

Send a message to a customer › Request Body

message

string

type

string

sub_type

string

attachment_ids

string[]

contact_id

string · uuid

contact_ids

string[]

team_user_id

string · uuid

business_location_id

string · uuid

location_id

string · uuid

createActivity

boolean

activity_type

string

activity_description

string

is_bot

boolean

enquiry_id

string · uuid

enquiry_status

string

campaign_id

string · uuid

name

string

email

string · email

phone

string

avatar

string

company_name

string

address

string

do_not_update

boolean

suppress_socket_events

boolean

Send a message to a customer › Responses

Message sent successfully. When campaign_id belongs to a paused campaign, the live route returns success: true with message Campaign is paused, message not sent. and no body.

success

boolean · required

message

string · required

object · required

Send a message on an existing enquiry

PUT

https://api.coax.com.au

/api/v2/message/{enquiry_id}/send/{channel}

Sends a message on a known enquiry over the chosen channel. Use this when you already have an enquiry_id. If you only have a customer's phone/email, prefer PUT /api/v2/message/send/{channel}.

Send a message on an existing enquiry › path Parameters

enquiry_id

string · uuid · required

channel

string · required

Send a message on an existing enquiry › 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.

Send a message on an existing enquiry › Request Body

message

string

type

string

sub_type

string

attachment_ids

string[]

contact_id

string · uuid

contact_ids

string[]

team_user_id

string · uuid

business_location_id

string · uuid

location_id

string · uuid

createActivity

boolean

activity_type

string

activity_description

string

is_bot

boolean

Send a message on an existing enquiry › Responses

Store a received message completed successfully.

success

boolean · required

message

string · required

object · required

Schedule a message to a customer

PUT

https://api.coax.com.au

/api/v2/message/schedule/{channel}

Schedules a message to be delivered later. Coax finds or creates the customer and enquiry from the supplied details before scheduling.

Schedule a message to a customer › path Parameters

channel

string · required

Schedule a message to 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.

Schedule a message to a customer › Request Body

message

string

type

string

sub_type

string

attachment_ids

string[]

contact_id

string · uuid

contact_ids

string[]

team_user_id

string · uuid

business_location_id

string · uuid

location_id

string · uuid

createActivity

boolean

activity_type

string

activity_description

string

is_bot

boolean

enquiry_id

string · uuid

enquiry_status

string

campaign_id

string · uuid

name

string

email

string · email

phone

string

avatar

string

company_name

string

address

string

do_not_update

boolean

suppress_socket_events

boolean

scheduled_at

string · date-time

customer_id

string · uuid

Schedule a message to a customer › Responses

Schedule a message without an enquiry ID completed successfully.

success

boolean · required

message

string · required

object · required

Schedule a message on an existing enquiry

PUT

https://api.coax.com.au

/api/v2/message/{enquiry_id}/schedule/{channel}

Schedules a message on a known enquiry. Use this when you already have an enquiry_id; otherwise use PUT /api/v2/message/schedule/{channel}.

Schedule a message on an existing enquiry › path Parameters

enquiry_id

string · uuid · required

channel

string · required

Schedule a message on an existing enquiry › 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.

Schedule a message on an existing enquiry › Request Body

message

string

type

string

sub_type

string

attachment_ids

string[]

contact_id

string · uuid

contact_ids

string[]

team_user_id

string · uuid

business_location_id

string · uuid

location_id

string · uuid

createActivity

boolean

activity_type

string

activity_description

string

is_bot

boolean

scheduled_at

string · date-time

Schedule a message on an existing enquiry › Responses

Schedule a message completed successfully.

success

boolean · required

message

string · required

object · required

Send a review request

PUT

https://api.coax.com.au

/api/v2/message/ask-for-review

Sends a review request to a customer. If the customer or enquiry does not exist yet, Coax will create them from the supplied details first. This is the simplest way to ask a customer for a review.

Send a review request › 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.

Send a review request › Request Body

channel

string

message

string

review_types

string

business_location_id

string · uuid

location_id

string · uuid

createActivity

boolean

activity_type

string

activity_description

string

object

enquiry_id

string · uuid

email

string · email

phone

string

name

string

company_name

string

address

string

avatar

string

do_not_update

boolean

object[]

customer_id

string · uuid

Send a review request › Responses

Review request sent successfully. Response message: Sent review request!.

success

boolean · required

message

string · required

object · required

Send a review request on an existing enquiry

PUT

https://api.coax.com.au

/api/v2/message/{enquiry_id}/ask-for-review

Sends a review request against a known enquiry. Use this when you already have an enquiry_id; otherwise use PUT /api/v2/message/ask-for-review.

Send a review request on an existing enquiry › path Parameters

enquiry_id

string · uuid · required

Send a review request on an existing enquiry › 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.

Send a review request on an existing enquiry › Request Body

channel

string

message

string

review_types

string

business_location_id

string · uuid

location_id

string · uuid

createActivity

boolean

activity_type

string

activity_description

string

object

Send a review request on an existing enquiry › Responses

Review request sent successfully. Response message: Sent review request!.

success

boolean · required

message

string · required

object · required