YM REST Services

MessageFolders

**Requires Authentication**
Requires any of the roles:	member, oauthmember, admin, oauthadmin	Required permission:	CanUseMessaging

The following routes are available for this service:
GET	/Ams/{ClientID}/Member/{MemberID}/MessageFolders	Return a list of message folders for a member.
POST	/Ams/{ClientID}/Member/{MemberID}/MessageFolders	Create 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:
Name	Parameter	Data Type	Required
FolderId	path	int?	No
FolderName	body	string	No
MessageCount	body	int?	No
MessageCountUnread	body	int?	No

**MemberBaseSharedDto** Parameters:
Name	Parameter	Data Type	Required	Description
MemberID	form	int	No

**BaseSharedDto** Parameters:
Name	Parameter	Data Type	Required
ClientID	form	int	No
ResponseStatus	form	ResponseStatus	No
BypassCache	form	bool	No
DateCached	form	DateTime	No
Device	form	Device	No

**MessageFolders** Parameters:
Name	Parameter	Data Type	Required
FolderId	path	int?	No
FolderName	body	string	No
MessageCount	body	int?	No
MessageCountUnread	body	int?	No

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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
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-03T08:21:36.9918390-04:00,
	Device: Desktop
}

HTTP/1.1 200 OK
Content-Type: text/jsv
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-03T08:21:36.9918390-04:00,
	Device: Desktop
}