Member Notes
View or add notes to a member record
Endpoint URL
https://api.cms-tool.net/api/membernotes
/api/membernotes
Read and update notes about members.
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. |
mbr_id | int | 123 | Filter results by mbr id. |
from_uid | int | 123 | Filter results by from uid. |
note_subject | text | example | Filter results by note subject. |
note_type | text | example | Filter results by note type. |
offset | int | 123 | Skip this many matching records before returning results. |
pageSize | int | 123 | Limit the number of records returned; accepted values are 1 through 999, with 200 used otherwise. |
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. |
mbr_id | int | 123 | Set the mbr id value. |
note_subject | text | example | Set the note subject value. |
note_body | text | example | Set the note body value. |
note_type | text | example | Set the note type value. |
Data definitions
| Field | Type | Description | Format | Example |
|---|---|---|---|---|
note_subject | text | Subject for the note | ||
note_type | text | eg **Note Re Message**, or **Sent Mail** | ||
note_body | text | The main content of the note | ||
note_id | serial | Unique ID | ||
about_uid | int | What customer is this note regarding. All notes need to be about a member. | ||
note_time | timestamp | Timestamp when the note was made | ||
note_re_msgid | int | If this is a note (reply) about a message or enquiry then use the message ID here | ||
from_uid | int | Which staff member created this note |
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.
{
"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
}