ListMessage
Returns the list of messages for the specified object that has messages (Bill, Vendor Credit, Invoice, Credit Memo, etc.)
Example
Request
<API End Point URL>/ListMessage.json
data={
"objectId" : "00n01TUPMWVLJHJUR1mg",
"start" : 0,
"max" : 999
}
Response
{
"response_status" : 0,
"response_message" : "Success",
"response_data" : [ {
"entity" : "Message",
"id" : "act01QYSTNGJNYXxo57v",
"objectId" : "00n01TUPMWVLJHJUR1mg",
"message" : "this is a private message for [~00601TGDFFSIBFXKAQV2]",
"isPublic" : false,
"createdDate" : "2016-10-03T22:36:36.000+0000",
"usersId" : "00601YWDIZDIIHMAoyqc",
"from" : {
"usersOrgName" : "sOshiology Music Company",
"usersFirstName" : "Ezra",
"usersLastName" : "Lam"
}
}, {
"entity" : "Message",
"id" : "act01TWFZSLJBUIxo53k",
"objectId" : "00n01TUPMWVLJHJUR1mg",
"message" : "This is a public facing message to the network connection",
"isPublic" : true,
"createdDate" : "2016-09-01T22:35:33.000+0000",
"usersId" : "00601YWDIZDIIHMAoyqc",
"from" : {
"usersOrgName" : "sOshiology Music Company",
"usersFirstName" : "Ezra",
"usersLastName" : "Lam"
}
} ]
}
Resources
- Vendors
- Payable Transactions
- Send a note to a vendor
- Customers
- Receivable Transactions
- Send a note to a customer
Parameters
Field Name | Description | Required? |
---|---|---|
objectID | The parent object ID of the message (Bill, Invoice, etc.). | Yes |
start | Start index of the row (0 based) | No |
max | Maximum number of messages to retrieve | No |