List Conversations Undocumented Feature

[lmsstaff]

Currently in the 'List Conversations' API docs, the 'scope[]' parameter accepts only the values of 'unread', 'starred' and 'archived', with the default being all non-archived conversations for the user.  

However, there is an undocumented feature of the scope of 'sent'.  By passing in this value, you are able to retrieve all sent conversations in the user's sent folder.  This is a very handy feature as you can possibly be proactive in searching for abusive messages sent between users.

🔎 This idea has been archived. While this idea isn't open for comments, it is an important part of Instructure’s idea conversations and development process. Contributions like this are valuable as Instructure prioritizes work on new or existing features.

[KristinL]

Hi @lmsstaff -

Thank you for taking the time to share an Idea!

Before we request an update to our documentation, it would be great to verify that this (or isn't) is officially supported by Canvas.

Our L2 Support Team shared that sometimes there are reasons for undocumented API endpoints. They also asked if you'd be willing to create a ticket. They'd like to take a closer look.

From there, we'll determine if this should be forwarded to our Documentation Team or if this thread to be a request for more official support for the API feature. 

[KristinL]

Hi @lmsstaff -

I'm checking on this Idea, and I hope things are going well!

Were you able to collaborate with Support? If so, what did you learn? We know life can get busy, yet if we don't hear from you by March 22, we will archive this thread so we can better focus on current requests. 

[lmsstaff]

Thanks.

Support states that sometimes endpoints are left in the API call as they are sometimes used as testing points for internal support issues.  They are not going to document them and state that they basically may disappear over time.

[KristinL]

Hi @lmsstaff - Thank you for following up! Because of the response and direction from Support, this thread is being Archived.