GET v1/receivedmailings?recipientEmailAddress={recipientEmailAddress}&includeLocations={includeLocations}
Return a list of events received by the given email address.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| recipientEmailAddress |
The email address for which we wish to load received mailings |
string |
Required |
| includeLocations |
A boolean value indicating whether to include location information in the results |
boolean |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of ReceivedMailing| Name | Description | Type | Additional information |
|---|---|---|---|
| CardUrl |
A direct link to the invitation page. |
string |
None. |
| Date |
The date of the event, if available, otherwise, the date that the invitation was sent. |
date |
None. |
| EventName |
The name of the event. |
string |
None. |
| EventTimeZone |
The time zone in which the event is set to occur. |
string |
None. |
| Locations |
The locations for this event. |
Collection of Location |
None. |
| RSVPStatus |
The RSVP status of this recipient for this event. This will hold a value of "Attending", "Not Attending" or "Not Responded". |
string |
None. |
| SenderName |
The name of the sender of the event. |
string |
None. |
| ThumbnailUrl |
A link to the a thumbnail image of the card. |
string |
None. |
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.