Messages

The Messages service allows messages to be sent to one or more recipients.
  1. Supported Roles
  2. Available Services
    1. Messages
  3. Message Description
  4. Expansions
  5. API Explorer

Supported Roles

Role Reads? Writes?
IDX Yes Yes
VOW Yes Yes
Private Yes Yes
More information about roles may be found here.

Available Services

Messages

HTTP Method Description Notes
POST Delivers a new message Restricted to one message at a time
GET,PUT,DELETE Returns HTTP 405 (Method Not Allowed) Not implemented

POST Request

Example: 
{
    "D": {
        "Messages": [
            {
                "Type": "ShowingRequest",
                "EventDateTime": "2011-09-15T14:00:00",
                "SenderId": "20110112234857732941000000",
                "Subject": "Showing Request For 123 Main St, MLS # 12-345",
                "Body": "A showing is requested for ...",
                "ListingId": "20110112234857732941000000"
            }
        ]
    }
}
 

POST Response

The standard success/fail response format is returned.

Message Description

Attribute Data Type Writeable? Required? Description
Type Character Yes Yes Supported message types are:
  • ShowingRequest: a request to schedule a showing for a listing at a specific date and time.
  • General: a generic message that does not fall in to any other type.
EventDateTime DateTime Yes When Type=ShowingRequest The requested showing date.
ListingId Character Yes When Type=ShowingRequest The ID of the listing related to the message.
SenderId Character Yes No Used when the sender will not be the current user. Supported only for IDX roles when a contact not logged in to their VOW account wishes to contact their agent.
Recipients Array of Characters Yes No Users who will receive the message.
Subject Character Yes No The subject of the message. 500 characters max
Body Character Yes No Message body.

Expansions

None.

API Explorer

The API Explorer does not currently support this service.