Enquiries - API Reference

Enquiries

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

End Point URL

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

API Parameters and Filters

Name	Description	Example	Optional	Data type
data	The JSON you would like to POST. This can be POST content also	{ }	Yes	json object
id	Search a specific message by it's id	id=123	Yes	int
mbr_id	Search messages which were posted by a mbr_id	mbr_id=1234	Yes	int
postedAfter	Search messages which were posted after the time provided.	postedAfter="2021-01-01"	Yes	string
postedBefore	Search messages which were posted before the time provided.	postedBefore="2021-12-31"	Yes	string
orderby	Sort the results by latest date.	orderby = "date"	Yes	string
forum_info_id or info_id	Messages on a specific blog	forum_info_id=123123	Yes	int
forum_pid or pid	Messages on a specific product	pid=123123	Yes	int
msg_group_id	Forum posts from a specific group	msg_group_id=1234	Yes	int
msg_re	Replies to existing comments	msg_re=123	Yes	int

Data Dictionary

Key	Definition	Type	Format
msgid	ID Unique serial ID for the message	Integer (Unique ID)	e.g. 123456
body	Content Content of the message	text
cid	Website ID Internal ID to match with the Website	int	e.g. 123456
closed_by_mbr_id	Staff ID Completed The staff member who considered this enquiry was closed.	int
closed_date	Date Completed If the merchant has received and dealt with the message, they can mark it as closed by setting this date	timestamp	e.g. 2025-12-31 23:59:59
enquirystatus	Status Status of the enquiry if using the CRM to manage enquiries	text
from_ip	IP Address IP Address of the sender	text
from_name	Sender Name Contact Name of the sender	text
from_phone	Sender Phone Phone number of enquirer	text
msg_debug	msg debug For internal use only	text
msg_net_score	Net score Net Promo Score	int
msg_other_data_json	Other Data Additional answers to custom questions and form data will be stored here	json
msg_utm_json	UTM Tracking Data utmSource,utmMedium,utmCampaign	json
notifywheninstock	Notify when instock Should the user be contacted automatically once the product is back in stock?	bool	true/false
page	Page ID Which page was most relevant to this message, often the contact us page or home page if none other	int	e.g. 123456
posted_by_mbr_id	Member ID The ID of the user / customer who made this enquiry	int
re_bookingid	Booking ID If regarding a booking, then the booking ID else 0	int
recipient	Recipient Email To which email address was it sent, usually the merchant address, but could be different	text
re_eventid	Event ID If regarding an event, then the Event ID else 0	int
re_info_id	Blog ID If regarding a blog, then the Blog ID else 0	int
re_listing_id	Listing ID If regarding a directory listing, then the listing ID else 0	int
re_pid	Product ID If regarding a product, then the product ID else 0, eg for product enquiries	int
repliedon	Reply Timestamp The time that that the webmaster replied to this message, not the date of this message.	timestamp	e.g. 2025-12-31 23:59:59
subject	Subject Subject of the message	text
submitted	Date Submitted The date the enquiry was initially made	timestamp	e.g. 2025-12-31 23:59:59
submitter	Sender Email EMail address of the sender	text

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
}