Forum Discussion

iahiqosolutions's avatar
iahiqosolutions
Advisor
13 years ago

Private messaging via REST API

I do apologize if this has already been asked and answered (I looked through support and knowledge base but couldn't find it).   I want to implement private messaging functionality via REST API. I...
  • AdamN's avatar
    AdamN
    13 years ago

    Hi iahiqosolutions,

     

    Regarding the methods you could not find:

    • Change message status on "Unread" or "New"
      • The "Note" class has a "markread" method. There doesn't appear to be a way to mark it new/unread.
    • Get message status("Read", "Unread" or "New")
      • There's no method or attribute to get the status directly; however, you can retreive only unread messages using the "mailbox/notes/inbox/unread" method on the "User" class.
    • Sort private messages in the inbox or outbox by Sent or Received date(Descending and Ascending)
    • Sort private messages in the inbox or outbox by Subject(Descending and Ascending)
      • There currently are not parameters available for sorting the notes in the response.

    Regards,

     

    Adam

AdamN's avatar
AdamN
Khoros Oracle

Hi iahiqosolutions,

 

Regarding the methods you could not find:

  • Change message status on "Unread" or "New"
    • The "Note" class has a "markread" method. There doesn't appear to be a way to mark it new/unread.
  • Get message status("Read", "Unread" or "New")
    • There's no method or attribute to get the status directly; however, you can retreive only unread messages using the "mailbox/notes/inbox/unread" method on the "User" class.
  • Sort private messages in the inbox or outbox by Sent or Received date(Descending and Ascending)
  • Sort private messages in the inbox or outbox by Subject(Descending and Ascending)
    • There currently are not parameters available for sorting the notes in the response.

Regards,

 

Adam

luk's avatar
luk
Boss
8 years ago
I guess there are now sorting options with API v2:

https://community.lithium.com/t5/Developer-Documentation/bd-p/dev-doc-portal?section=commv2&collection=inbox_notes
https://community.lithium.com/t5/Developer-Documentation/bd-p/dev-doc-portal?section=commv2&collection=outbox_notes#action-update

an interesting one I found in v1 was a "notes.metadata" property, but nobody could tell me anything about it, see at the very bottom of the URL parameters here: https://community.lithium.com/t5/Developer-Documentation/bd-p/dev-doc-portal?section=commv1&leaf-id=Community.postoffice.notes.send#Community.postoffice.notes.send

What is this metadata intended for and how can we retrieve it via API?