CMS Tool API schema

Public API version 1.4.10.

Enquiries

A message is created for every contact us, enquiry form, or custom form.

Endpoint URL

https://api.cms-tool.net/api/message

`/api/message`

Read and update form submissions and enquiries.

GET

List records, or retrieve one by appending its ID to the path.

Query parameters

Name	Type	Example	Notes
`id`	int	`123`	Filter results by id.
`page`	int	`123`	Filter results by page.
`mbr_id`	int	`123`	Filter results by mbr id.
`postedAfter`	date	`2026-09-24T14:30:00+12:00`	Filter results by posted after.
`postedBefore`	date	`2026-09-24T14:30:00+12:00`	Filter results by posted before.
`offset`	int	`123`	Skip this many matching records before returning results.
`pageSize`	int	`123`	Limit the number of records returned.

POST

Create or update a record from a JSON object.

Request content type: application/json

Request body fields

Name	Type	Example	Notes
`id`	int	`123`	Set the id value.
`page`	int	`123`	Set the page value.
`submitter`	text	`example`	Set the submitter value.
`subject`	text	`example`	Set the subject value.
`body`	text	`example`	Set the body value.
`from_name`	text	`example`	Set the from name value.
`from_phone`	text	`example`	Set the from phone value.
`re_pid`	int	`123`	Set the re pid value.
`re_eventid`	int	`123`	Set the re eventid value.

Data definitions

Field	Type	Description	Example
`submitter`	text	EMail address of the sender
`closed_date`	timestamp	If the merchant has received and dealt with the message, they can mark it as closed by setting this date	2025-12-31 23:59:59
`from_phone`	text	Phone number of enquirer
`subject`	text	Subject of the message
`msgid`	serial	Unique serial ID for the message	123456
`posted_by_mbr_id`	int	The ID of the user / customer who made this enquiry
`closed_by_mbr_id`	int	The staff member who considered this enquiry was closed.
`from_name`	text	Contact Name of the sender
`body`	text	Content of the message
`msg_utm_json`	json	utmSource,utmMedium,utmCampaign
`notifywheninstock`	bool	Should the user be contacted automatically once the product is back in stock?
`from_ip`	text	IP Address of the sender
`re_eventid`	int	If regarding an event, then the Event ID else 0
`submitted`	timestamp	The date the enquiry was initially made	2025-12-31 23:59:59
`enquirystatus`	text	Status of the enquiry if using the CRM to manage enquiries
`repliedon`	timestamp	The time that that the webmaster replied to this message, not the date of this message.	2025-12-31 23:59:59
`re_info_id`	int	If regarding a blog, then the Blog ID else 0
`recipient`	text	To which email address was it sent, usually the merchant address, but could be different
`re_bookingid`	int	If regarding a booking, then the booking ID else 0
`page`	int	Which page was most relevant to this message, often the contact us page or home page if none other	123456
`re_pid`	int	If regarding a product, then the product ID else 0, eg for product enquiries
`msg_other_data_json`	json	Additional answers to custom questions and form data will be stored here
`re_listing_id`	int	If regarding a directory listing, then the listing ID else 0
`msg_net_score`	int	Net Promo Score

Usage instructions and examples

Create a new Message Post

To create a new message use POST method and do not provide any Message Id.
Provide the mbr_id if known or member email address as mbr_from.

Example if mbr_id is known:

{

"mbr_id" : 12345,

"from_name": "Example Name",

"subject": "Subject of the post",

"body": "Example post body",

"page": 123

}

Example if mbr_id not known:

{

"submitter" : "example@email.com",

"from_name": "Example Name",

"subject": "Subject of the post",

"body": "Example post body",

"page": 123

}

Sample object

        {
            "submitter": "testemail@test.co.nz",
            "from_phone": "021123123",
            "subject": "Make a Booking 2021-12-14 15:00:00",
            "mbr_id": 1234,
            "msgid": 1413,
            "posted_by_mbr_id": 1234,
            "closed_by_mbr_id": 0,
            "from_name": "John",
            "body": "No comment was provided with booking ID:123",
            "msg_debug": " ",
            "re_eventid": 0,
            "submitted": "2021-12-13 13:43:52.0",
            "re_info_id": 0,
            "re_bookingid": 123,
            "id": 1413,
            "page": 2222,
            "re_pid": 1234,
            "re_listing_id": 0,
            "msg_net_score": 0,
            "cid": 1234
        }

Machine-readable documentation

This documentation is also available as JSON or Markdown at the same URL. Request JSON with Accept: application/json or Markdown with Accept: text/markdown.