| Name | Type | Description |
|---|---|---|
announcement
(before 1.5 named event)
|
string | Since 1.0.18 Announcement event type: participant_joined,
participant_left, title_changed or icon_changed |
| appData | string | Since 1.0.10 Optional data provided by the app that generated the message |
| body | string | Message body |
| bubble | object | Since 1.0.11 Bubbled message properties |
| bubble. bubbled | datetime | Read-only Last time bubbling took place |
| bubble. numRecentCommenters | boolean | Read-only Number of commenters since message was last bubbled |
| bubble. reason | string | Since 1.5.6 Read-only Reason why the message bubbled:
new_comment, date_time_changed, location_changed or
details_changed |
| commentable | boolean | Whether or not comments may be posted on the message |
| created | datetime | Read-only Date the message was created (ISO 8601 compliant) |
| data | datetime | Since 1.0.18 Read-only Data relevant to the announcement |
| deletedBy | string | Since 1.0 Read-only If applicable, information on the user that deleted the message |
| EID | EID | Unique entity identifier |
| embeds | array | Since 1.0.17 List of embedded URLs |
| event | object | Since 1.5 Event details event |
| file | object | Read-only Optional file information (in case of messageType ``file`) <file>` |
| headerBackgroundUrl | string | Since 1.1.14 Read-only URL of the header background |
| htmlBody | string | Since 1.1.14 HTML5 body (only for news messageType). Note that
the body and htmlBody fields are mutually exclusive in a write
context. When retrieving, the HTML body is converted to plain text
in the body field for backward compatibility |
| lastModified | datetime | Since 1.1.14 Read-only When the message was last modified
(only for messageType news and update) |
| lastEdited | datetime | Since 1.1.14 Read-only When content of the message was last
edited (only for messageType news and update) |
| localizableBody | object | Since 1.0.8 Localizable message body |
| localizableBody. <locale> | string | Body in the language of the RFC 5646/4647 <locale> |
| mentions | array | Since 1.0.17 List of mentions |
| messageType | string | Read-only Message type: update, comment, file, news,
private event, app_update or announcement |
| numRecipients | number | Since 1.0.26 Read-only Number of recipients |
| numAttachments | number | Since 1.0.16 Read-only Number of attachments |
| numComments | number | Read-only Number of comments |
| numFiles | number | Since 1.4 Read-only Number of attached files |
| numImages | number | Since 1.4 Read-only Number of attached images |
| numLikes | number | Since 1.0.16 Read-only Number of likes |
| numVideos | number | Since 1.4 Read-only Number of attached videos |
| numVideoViews | number | Since 1.6.6 Read-only Number of video views |
| status | string | Since 1.1.14 For news messages, this can be draft or
published |
| superseeded | boolean | Since 1.3 Read-only This only applies in the context of an edit-history and signifies that this is not the latest version |
| teaserThumbnailUrl | URI | File URL to news teaser image thumbnail |
| title | string | News message title |
| type | string | “message” |
| Name | Type | Description |
|---|---|---|
| allDay | boolean | Whether or not the event lasts all day |
| end | object | Exclusive! end date/time of an event |
| end. date | string | End date (ISO 8601 YYYY-MM-DD) |
| end. time | string | End time (ISO 8601 hh:mm) of non-all-day event |
| end. timeZone | string | End time zone (IANA zone name) of non-all-day event |
| end. timeZoneOffset | string | Read-only Time zone offset at end date/time (±hh:mm) |
| start | object | Start date/time of an event |
| start. date | string | Start date (ISO 8601 YYYY-MM-DD) |
| start. time | string | Start time (ISO 8601 hh:mm) of non-all-day event |
| start. timeZone | string | Start time zone (IANA zone name) of non-all-day event |
| start. timeZoneOffset | string | Read-only Time zone offset at start date/time (±hh:mm) |
| location | object | Location |
| location. description | string | Human-readable description of the location |
| responderCounts | object | Users that RSVP’ed (counts per answer option) |
| responderCounts. yes | number | Number of users that responded they will attend the event |
| responderCounts. maybe | number | Number of users that said they might attend the event |
| responderCounts. no | number | Number of users that said they won’t attend the event |
| responderCounts. unspecified | number | Number of users that did not yet respond to the event |
| Name | Type | Description |
|---|---|---|
| desktopThumbnailUrl | URI | File URL to thumbnail |
| metadata | string | Meta-data to describe the embed |
| url | URI | URL used for linking the embed |
| Name | Type | Description |
|---|---|---|
| EID | EID | Unique entity identifier of the mentioned user |
| length | integer | String length of the mention |
| offset | integer | Offset of the mention in the message body |
| type | string | Mentioned type ('user') |
| Name | Type | Description |
|---|---|---|
| file. displayUrls | object | URLs for different file formats |
| file.displayUrls. profileImage | string | Preview for use on profile page (Retina) |
| file.displayUrls. thumbnail | string | Generic web thumbnail (Retina) |
| file.displayUrls. timelinePreviewSmall | string | Preview for use with timeline (small, non-Retina) |
| file.displayUrls. timelinePreviewLarge | string | Preview for use with timeline (large, non-Retina) |
| file. extension | string | The file’s extension (without leading dot) |
| file. filename | string | Filename |
| file. hasSubfolders | boolean | Since 1.0.24 Whether there are subfolders in this folder |
| file. mimeType | string | MIME type ("inode/directory" for folders) |
| file. name | string | Name of the file (typically, but not necessarily, this is the same as the filename without extension) |
| file. numChildren | integer | Number of direct children |
| file. path | array | Since 1.0.24 List of folders. |
| file. size | integer | File size in bytes |
| file. trashed | boolean | Whether or not the file has been removed |
| file. type | string | File type: avatar, background_image, document,
emblem, file, folder, icon, image,
inline_image, news_background_image,
profile_background_image, teaser_image or
video |
| file. url | URI | URL to the (original) attachment |
| file. dimensions | object | Dimensions (only for image files uploaded since API version 1.3.6) |
| file.dimensions. width | integer | Since 1.3.6 Width in pixels |
| file.dimensions. height | integer | Since 1.3.6 Height in pixels |
| file.dimensions. aspectRatio | string | Since 1.3.6 Aspect ratio of the image (not guaranteed) |