YM REST Services

<back to all web services

MessageFolders

Requires Authentication
Requires any of the roles:member, oauthmember, admin, oauthadminRequired permission:CanUseMessaging
The following routes are available for this service:
GET/Ams/{ClientID}/Member/{MemberID}/MessageFoldersReturn a list of message folders for a member.
POST/Ams/{ClientID}/Member/{MemberID}/MessageFoldersCreate a folder for a member.
DELETE/Ams/{ClientID}/Member/{MemberID}/MessageFolders/{FolderId}Delete a message for a member.
PUT/Ams/{ClientID}/Member/{MemberID}/MessageFolders/{FolderId}Update a folder (rename) for a member.
MessageFolders Parameters:
NameParameterData TypeRequiredDescription
FolderIdpathint?No
FolderNamebodystringNo
MessageCountbodyint?No
MessageCountUnreadbodyint?No
MemberBaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
MemberIDformintNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
MessageFolders Parameters:
NameParameterData TypeRequiredDescription
FolderIdpathint?No
FolderNamebodystringNo
MessageCountbodyint?No
MessageCountUnreadbodyint?No

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Ams/{ClientID}/Member/{MemberID}/MessageFolders HTTP/1.1 
Host: ws.yourmembership.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"FolderId":0,"FolderName":"String","MessageCount":0,"MessageCountUnread":0,"MemberID":0,"ClientID":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"BypassCache":false,"DateCached":"2024-05-03T00:25:18.0079061-04:00","Device":"Desktop"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"FolderId":0,"FolderName":"String","MessageCount":0,"MessageCountUnread":0,"MemberID":0,"ClientID":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"BypassCache":false,"DateCached":"2024-05-03T00:25:18.0079061-04:00","Device":"Desktop"}