Member Notes - API Reference

Member Notes

View or add notes to a member record

End Point URL

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

API Parameters and Filters

Name	Description	Example	Optional	Data type
data	The JSON you would like to POST. This can be POST content also	data = { "note_subject" : "notes from api", "note_body" : "This is a new note" }	Yes	json object
id	Search a specific note (aka note_id)	id=2334453	Yes	int
mbr_id	Search a note related to a Member id	mbr_id=123	Yes	int
note_subject	Search a note by it's subject	note_subject=Important	Yes	string
note_type	Search a note by it's type	note_type=Work	Yes	string
note_body	Search a note by it's body content	note_body=Example for note	Yes	string
note_time	Search note which was created after or before the time provided. Use matchType parameter along for more control over the data.	note_time=01/01/2020 matchType=>	Yes	string

Data Dictionary

Key	Definition	Type	Format
about_uid	About Member ID What customer is this note regarding. All notes need to be about a member.	int
cid	Website ID Website connected to this note	int
from_uid	Staff ID Which staff member created this note	int
note_body	Note Content The main content of the note	text
note_id	ID Unique ID	Integer (Unique ID)
note_re_msgid	Regarding Message ID If this is a note (reply) about a message or enquiry then use the message ID here	int
note_subject	Subject Subject for the note	text
note_time	Time Timestamp when the note was made	timestamp
note_type	Type eg Note Re Message, or Sent Mail	text

Usage Instructions and Examples

Add a new note

To add a new notes do not provide any Note Id. Provide a mbr_id if known or a member email address and member name to record the note against a member. If no member exists system will create a new member for the email address.
Rest of the details will be used to create the new note.

Example when mbr_id is known.

"mbr_id": 1234,

"note_subject": "notes from api",

"note_body": "body of note"

}

Example when mbr_id is not known.

{

"mbr_email": "test@email.com",

"mbr_name": "member name",

"note_subject": "notes from api",

"note_body": "body of note"

}

Update an existing note

To update a note provide it's ID. You can update the subject, body, note type of any note.

Example:

{

"note_id": 1234,

"note_subject": "notes from api",

"note_body" : "body of note"

}

Sample Object


{"note_subject":"this is a test note.",
"note_body":"note regarding something",
"note_id":1234,
"about_uid":567,
"id":1234,
"note_time":"2021-07-15 12:21:35.151008",
"note_re_msgid":0,
"from_uid":40,
"cid":128528
}