YM REST Services

<back to all web services

Messages

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}/MessagesReturn a list of messages.
POST/Ams/{ClientID}/Member/{MemberID}/MessagesSend a message.
PUT/Ams/{ClientID}/Member/{MemberID}/MessagesMark Message as read, archived, moved to a folder, etc.
GET/Ams/{ClientID}/Member/{MemberID}/Messages/{MessageId}Return the details of a message.
DELETE/Ams/{ClientID}/Member/{MemberID}/Messages/{MessageId}Delete a message.
Messages Parameters:
NameParameterData TypeRequiredDescription
MessageIdsbodyList<int>No
MessageIdpathintNo
SenderIdbodyintNo
UpdateActionbodyUpdateActionNo

Allowable Values

  • None
  • Read
  • Unread
  • Archive
  • Move
FolderTypebodyFolderTypeNo

Allowable Values

  • Inbox
  • Sent
  • Deleted
  • Draft
  • Junk
  • Personal
SubjectbodystringNo
BodybodystringNo
RecipientIdbodyint?No
FolderIdbodyint?No
MessageTypeIdbodystringNo
IsRichTextbodybool?No
ExpiresbodyDateTime?No
DateShowbodyDateTime?No
AttachmentPathbodystringNo
SenderNamebodystringNo
RecipientNamebodystringNo
AttachmentSizebodyintNo
PageSizebodyint?No
PageNumberbodyint?No
AttachmentbodystringNo
AttachmentNamebodystringNo
MemberBaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
MemberIDformintNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
MessageResponse Parameters:
NameParameterData TypeRequiredDescription
FolderNameformstringNo
MessageDateformDateTimeNo
IsReadformbool?No
HasAttachmentsformboolNo
SenderHeadshotImageformstringNo
RecipientHeadshotImageformstringNo

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}/Messages HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	MessageIds: 
	[
		0
	],
	MessageId: 0,
	SenderId: 0,
	UpdateAction: None,
	FolderType: Inbox,
	Subject: String,
	Body: String,
	RecipientId: 0,
	FolderId: 0,
	MessageTypeId: String,
	IsRichText: False,
	Expires: 0001-01-01,
	DateShow: 0001-01-01,
	AttachmentPath: String,
	SenderName: String,
	RecipientName: String,
	AttachmentSize: 0,
	PageSize: 0,
	PageNumber: 0,
	Attachment: String,
	AttachmentName: String,
	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-03T05:18:03.3389218-04:00,
	Device: Desktop
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	FolderName: String,
	MessageDate: 0001-01-01,
	IsRead: False,
	HasAttachments: False,
	SenderHeadshotImage: String,
	RecipientHeadshotImage: String,
	MessageIds: 
	[
		0
	],
	MessageId: 0,
	SenderId: 0,
	UpdateAction: None,
	FolderType: Inbox,
	Subject: String,
	Body: String,
	RecipientId: 0,
	FolderId: 0,
	MessageTypeId: String,
	IsRichText: False,
	Expires: 0001-01-01,
	DateShow: 0001-01-01,
	AttachmentPath: String,
	SenderName: String,
	RecipientName: String,
	AttachmentSize: 0,
	PageSize: 0,
	PageNumber: 0,
	Attachment: String,
	AttachmentName: String,
	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-03T05:18:03.3389218-04:00,
	Device: Desktop
}