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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<Messages xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YM.Web.Services.Ams">
  <BypassCache xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">false</BypassCache>
  <ClientID xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">0</ClientID>
  <Device xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">Desktop</Device>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <MemberID xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">0</MemberID>
  <Attachment>String</Attachment>
  <AttachmentName>String</AttachmentName>
  <AttachmentPath>String</AttachmentPath>
  <AttachmentSize>0</AttachmentSize>
  <Body>String</Body>
  <DateShow>0001-01-01T00:00:00</DateShow>
  <Expires>0001-01-01T00:00:00</Expires>
  <FolderId>0</FolderId>
  <FolderType>Inbox</FolderType>
  <IsRichText>false</IsRichText>
  <MessageId>0</MessageId>
  <MessageIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </MessageIds>
  <MessageTypeId>String</MessageTypeId>
  <PageNumber>0</PageNumber>
  <PageSize>0</PageSize>
  <RecipientId>0</RecipientId>
  <RecipientName>String</RecipientName>
  <SenderId>0</SenderId>
  <SenderName>String</SenderName>
  <Subject>String</Subject>
  <UpdateAction>None</UpdateAction>
</Messages>

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

<MessageResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YM.Web.Services.Ams">
  <BypassCache xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">false</BypassCache>
  <ClientID xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">0</ClientID>
  <Device xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">Desktop</Device>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <MemberID xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">0</MemberID>
  <Attachment>String</Attachment>
  <AttachmentName>String</AttachmentName>
  <AttachmentPath>String</AttachmentPath>
  <AttachmentSize>0</AttachmentSize>
  <Body>String</Body>
  <DateShow>0001-01-01T00:00:00</DateShow>
  <Expires>0001-01-01T00:00:00</Expires>
  <FolderId>0</FolderId>
  <FolderType>Inbox</FolderType>
  <IsRichText>false</IsRichText>
  <MessageId>0</MessageId>
  <MessageIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </MessageIds>
  <MessageTypeId>String</MessageTypeId>
  <PageNumber>0</PageNumber>
  <PageSize>0</PageSize>
  <RecipientId>0</RecipientId>
  <RecipientName>String</RecipientName>
  <SenderId>0</SenderId>
  <SenderName>String</SenderName>
  <Subject>String</Subject>
  <UpdateAction>None</UpdateAction>
  <FolderName>String</FolderName>
  <HasAttachments>false</HasAttachments>
  <IsRead>false</IsRead>
  <MessageDate>0001-01-01T00:00:00</MessageDate>
  <RecipientHeadshotImage>String</RecipientHeadshotImage>
  <SenderHeadshotImage>String</SenderHeadshotImage>
</MessageResponse>