Messaging
Spaces, categories and channels organise in-system messages, attachments and preferences.
Object schema
Fields returned by List messages (one item from the collection). Individual endpoint pages document their complete response shapes.
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Required | Unique identifier. |
userId | null | string | Required | Owning account identifier. |
updatedAt | number | Required | Most recent update time. |
createdAt | number | Required | Creation time. |
deletedAt | null | number | Required | Deletion time; null when active. |
version | number | Required | Version used for optimistic concurrency checks. |
spaceId | string | Required | Space Id. |
channelId | string | Required | Channel Id. |
authorUserId | string | Required | Author User Id. |
authorMemberId | null | string | Required | Author Member Id. |
authorMemberDisplayName | null | string | Required | Author Member Display Name. |
authorMemberAvatarRef | null | string | Required | Author Member Avatar Ref. |
messageType | string | Required | Message Type. |
replyToMessageId | null | string | Required | Reply To Message Id. |
encryptionVersion | number | Required | Encryption Version. |
encryptionKeyId | string | Required | Encryption Key Id. |
encryptionIv | string | Required | Encryption Iv. |
encryptionAuthTag | string | Required | Encryption Auth Tag. |
contentFormat | string | Required | Content Format. |
gifMetadata | JSON value | Required | Gif Metadata. |
editedAt | null | number | Required | Edited At. |
content | string | Required | Text content. |
attachments | array<object> | Required | Attachments. |
attachments[].id | string | Required | Unique identifier. |
attachments[].userId | null | string | Required | Owning account identifier. |
attachments[].createdAt | number | Required | Creation time. |
attachments[].sortOrder | number | Required | Sort Order. |
attachments[].spaceId | string | Required | Space Id. |
attachments[].messageId | string | Required | Message Id. |
attachments[].storageRef | string | Required | Storage Ref. |
attachments[].fileName | string | Required | File Name. |
attachments[].mimeType | string | Required | Mime Type. |
attachments[].byteSize | number | Required | Byte Size. |
attachments[].width | null | number | Required | Width. |
attachments[].height | null | number | Required | Height. |
attachments[].durationMs | null | number | Required | Duration Ms. |
attachments[].attachmentKind | string | Required | Attachment Kind. |
linkPreviews | array<object> | Required | Link Previews. |
linkPreviews[].id | string | Required | Unique identifier. |
linkPreviews[].spaceId | string | Required | Space Id. |
linkPreviews[].channelId | string | Required | Channel Id. |
linkPreviews[].messageId | string | Required | Message Id. |
linkPreviews[].url | string | Required | Url. |
linkPreviews[].canonicalUrl | null | string | Required | Canonical Url. |
linkPreviews[].finalUrl | null | string | Required | Final Url. |
linkPreviews[].domain | string | Required | Domain. |
linkPreviews[].siteName | null | string | Required | Site Name. |
linkPreviews[].title | null | string | Required | Display title. |
linkPreviews[].description | null | string | Required | Description of the resource. |
linkPreviews[].imageUrl | null | string | Required | Image Url. |
linkPreviews[].imageWidth | null | number | Required | Image Width. |
linkPreviews[].imageHeight | null | number | Required | Image Height. |
linkPreviews[].faviconUrl | null | string | Required | Favicon Url. |
linkPreviews[].providerName | null | string | Required | Provider Name. |
linkPreviews[].status | string | Required | Status. Allowed values: "pending", "blocked", "success", "failed", "dismissed". |
linkPreviews[].errorCode | null | string | Required | Error Code. |
linkPreviews[].contentType | null | string | Required | Content Type. |
linkPreviews[].httpStatus | null | number | Required | Http Status. |
linkPreviews[].previewOrder | number | Required | Preview Order. |
linkPreviews[].fetchedAt | null | number | Required | Fetched At. |
linkPreviews[].createdAt | number | Required | Creation time. |
linkPreviews[].updatedAt | number | Required | Most recent update time. |
authorMemberAvatarUrl | null | string | Required | Author Member Avatar Url. |
authorMemberProfileStyle | null | object | Required | Author Member Profile Style. |
authorMemberProfileStyle.avatarRing | object | Optional | Avatar Ring. |
authorMemberProfileStyle.avatarRing.show | JSON value | Optional | Show. |
authorMemberProfileStyle.avatarRing.colorHex | JSON value | Optional | Color Hex. |
authorMemberProfileStyle.avatarRing.shape | JSON value | Optional | Shape. |
authorMemberProfileStyle.avatarRing.gradient | JSON value | Optional | Gradient. |
authorMemberProfileStyle.avatarRing.animation | JSON value | Optional | Animation. |
authorMemberProfileStyle.avatarRing.animationSpeed | JSON value | Optional | Animation Speed. |
authorMemberProfileStyle.avatarRing.strokeStyle | JSON value | Optional | Stroke Style. |
authorMemberProfileStyle.avatarRing.customMaskStorageId | JSON value | Optional | Custom Mask Storage Id. |
authorMemberProfileStyle.avatarRing.customMaskPathD | JSON value | Optional | Custom Mask Path D. |
authorMemberProfileStyle.bannerFrame | object | Optional | Banner Frame. |
authorMemberProfileStyle.bannerFrame.colorHex | JSON value | Optional | Color Hex. |
authorMemberProfileStyle.bannerFrame.showBorder | JSON value | Optional | Show Border. |
authorMemberProfileStyle.bannerFrame.borderWidthPx | JSON value | Optional | Border Width Px. |
authorMemberProfileStyle.bannerFrame.borderStyle | JSON value | Optional | Border Style. |
authorMemberProfileStyle.bannerFrame.cornerStyle | JSON value | Optional | Corner Style. |
authorMemberProfileStyle.memberName | object | Optional | Member Name. |
authorMemberProfileStyle.memberName.fontFamily | JSON value | Optional | Font Family. |
authorMemberProfileStyle.memberName.customFontId | JSON value | Optional | Custom Font Id. |
authorMemberProfileStyle.memberName.colorHex | JSON value | Optional | Color Hex. |
authorMemberProfileStyle.memberName.gradient | JSON value | Optional | Gradient. |
authorMemberProfileStyle.memberName.letterSpacing | JSON value | Optional | Letter Spacing. |
authorMemberProfileStyle.memberName.smallCaps | JSON value | Optional | Small Caps. |
authorMemberProfileStyle.memberName.textShadow | JSON value | Optional | Text Shadow. |
authorMemberProfileStyle.memberName.nameEffect | JSON value | Optional | Name Effect. |
authorMemberProfileStyle.bannerImage | object | Optional | Banner Image. |
authorMemberProfileStyle.bannerImage.brightness | JSON value | Optional | Brightness. |
authorMemberProfileStyle.bannerImage.contrast | JSON value | Optional | Contrast. |
authorMemberProfileStyle.bannerImage.tintHex | JSON value | Optional | Tint Hex. |
authorMemberProfileStyle.bannerImage.tintOpacity | JSON value | Optional | Tint Opacity. |
authorMemberProfileStyle.avatarImage | object | Optional | Avatar Image. |
authorMemberProfileStyle.avatarImage.brightness | JSON value | Optional | Brightness. |
authorMemberProfileStyle.avatarImage.contrast | JSON value | Optional | Contrast. |
authorMemberProfileStyle.avatarImage.tintHex | JSON value | Optional | Tint Hex. |
authorMemberProfileStyle.avatarImage.tintOpacity | JSON value | Optional | Tint Opacity. |
authorMemberProfileStyle.bannerOverlay | string | Optional | Banner Overlay. Allowed values: "none", "vignette", "soft-gradient", "film-grain", "glass-blur", "pattern-dots", "pattern-grid". |
authorMemberProfileStyle.profileBackgroundPattern | string | Optional | Profile Background Pattern. Allowed values: "grid", "none", "dots", "noise". |
authorMemberProfileStyle.heroLayout | string | Optional | Hero Layout. Allowed values: "shell-default", "avatar-centered", "avatar-left". |
authorMemberProfileStyle.accentColorHex | null | string | Optional | Accent Color Hex. |
authorMemberProfileStyle.profileBackgroundFill | object | Optional | Profile Background Fill. |
authorMemberProfileStyle.profileBackgroundFill.mode | JSON value | Optional | Mode. |
authorMemberProfileStyle.profileBackgroundFill.gradient | JSON value | Optional | Gradient. |
authorMemberProfileStyle.profileBackgroundFill.solidHex | JSON value | Optional | Solid Hex. |
authorMemberProfileStyle.pageBackgroundFill | object | Optional | Page Background Fill. Friend-only: full Friends viewport backdrop (solid/gradient). |
authorMemberProfileStyle.pageBackgroundFill.mode | JSON value | Optional | Mode. |
authorMemberProfileStyle.pageBackgroundFill.gradient | JSON value | Optional | Gradient. |
authorMemberProfileStyle.pageBackgroundFill.solidHex | JSON value | Optional | Solid Hex. |
authorMemberProfileStyle.panelBackgroundFill | object | Optional | Panel Background Fill. Friend-only: profile card panel fill (free: preset solids; Pro+: custom solid/gradient). |
authorMemberProfileStyle.panelBackgroundFill.mode | JSON value | Optional | Mode. |
authorMemberProfileStyle.panelBackgroundFill.gradient | JSON value | Optional | Gradient. |
authorMemberProfileStyle.panelBackgroundFill.solidHex | JSON value | Optional | Solid Hex. |
authorMemberProfileStyle.panelFillAccentHex | null | string | Optional | Panel Fill Accent Hex. Friend-only: optional accent mixed into the profile panel backdrop (Pro+). |
authorMemberProfileStyle.panelCardAccentHex | null | string | Optional | Panel Card Accent Hex. Friend-only: optional accent mixed into section cards (Pro+). |
authorMemberSystemTag | null | object | Required | Author Member System Tag. |
authorMemberSystemTag.name | string | Required | Name of the resource. |
authorMemberSystemTag.code | string | Required | Code. |
authorMemberSystemTag.color | string | Required | Color. |
authorMemberSystemTag.icon | string | Optional | Icon. |
replyTo | null | object | Required | Reply To. |
replyTo.id | string | Required | Unique identifier. |
replyTo.authorMemberId | null | string | Required | Author Member Id. |
replyTo.authorMemberDisplayName | null | string | Required | Author Member Display Name. |
replyTo.authorMemberAvatarUrl | null | string | Required | Author Member Avatar Url. |
replyTo.authorMemberProfileStyle | null | object | Required | Author Member Profile Style. |
replyTo.authorMemberProfileStyle.avatarRing | JSON value | Optional | Avatar Ring. |
replyTo.authorMemberProfileStyle.bannerFrame | JSON value | Optional | Banner Frame. |
replyTo.authorMemberProfileStyle.memberName | JSON value | Optional | Member Name. |
replyTo.authorMemberProfileStyle.bannerImage | JSON value | Optional | Banner Image. |
replyTo.authorMemberProfileStyle.avatarImage | JSON value | Optional | Avatar Image. |
replyTo.authorMemberProfileStyle.bannerOverlay | JSON value | Optional | Banner Overlay. |
replyTo.authorMemberProfileStyle.profileBackgroundPattern | JSON value | Optional | Profile Background Pattern. |
replyTo.authorMemberProfileStyle.heroLayout | JSON value | Optional | Hero Layout. |
replyTo.authorMemberProfileStyle.accentColorHex | JSON value | Optional | Accent Color Hex. |
replyTo.authorMemberProfileStyle.profileBackgroundFill | JSON value | Optional | Profile Background Fill. |
replyTo.authorMemberProfileStyle.pageBackgroundFill | JSON value | Optional | Page Background Fill. Friend-only: full Friends viewport backdrop (solid/gradient). |
replyTo.authorMemberProfileStyle.panelBackgroundFill | JSON value | Optional | Panel Background Fill. Friend-only: profile card panel fill (free: preset solids; Pro+: custom solid/gradient). |
replyTo.authorMemberProfileStyle.panelFillAccentHex | JSON value | Optional | Panel Fill Accent Hex. Friend-only: optional accent mixed into the profile panel backdrop (Pro+). |
replyTo.authorMemberProfileStyle.panelCardAccentHex | JSON value | Optional | Panel Card Accent Hex. Friend-only: optional accent mixed into section cards (Pro+). |
replyTo.authorMemberSystemTag | null | object | Required | Author Member System Tag. |
replyTo.authorMemberSystemTag.name | string | Required | Name of the resource. |
replyTo.authorMemberSystemTag.code | string | Required | Code. |
replyTo.authorMemberSystemTag.color | string | Required | Color. |
replyTo.authorMemberSystemTag.icon | JSON value | Optional | Icon. |
replyTo.snippet | string | Required | Snippet. |
replyTo.deletedAt | null | number | Required | Deletion time; null when active. |
mentions | array<object> | Required | Mentions. |
mentions[].type | string | Required | Type. Allowed values: "dynamic", "member". |
mentions[].id | string | Required | Unique identifier. |
mentions[].label | string | Required | Label. |
mentions[].href | null | string | Required | Href. |
mentions[].isVisible | boolean | Required | Is Visible. |
mentions[].fallbackReason | string | Optional | Fallback Reason. Allowed values: "unknown", "hidden", "deleted". |
encryptedContent | string | Required | Encrypted Content. Encrypted stored content included by the current service response. |
Endpoints
47 operations
GETGet attachment access url
/api/v1/messaging/attachments/{attachmentId}/access-urlPOSTComplete attachment upload/api/v1/messaging/attachments/completePOSTCreate attachment upload intent/api/v1/messaging/attachments/upload-intentGETGet messaging bootstrap/api/v1/messaging/bootstrapPATCHSet category collapsed/api/v1/messaging/categories/{categoryId}/collapsedPATCHUpdate category/api/v1/messaging/categories/{categoryId}DELETEDelete category/api/v1/messaging/categories/{categoryId}GETList messages around anchor/api/v1/messaging/channels/{channelId}/messages/aroundGETList messages newer/api/v1/messaging/channels/{channelId}/messages/newerGETList messages/api/v1/messaging/channels/{channelId}/messagesPOSTSend message/api/v1/messaging/channels/{channelId}/messagesPATCHMove channel/api/v1/messaging/channels/{channelId}/moveDELETEUnpin message/api/v1/messaging/channels/{channelId}/pins/{messageId}GETList pinned messages/api/v1/messaging/channels/{channelId}/pinsPOSTPin message/api/v1/messaging/channels/{channelId}/pinsPOSTMark channel read/api/v1/messaging/channels/{channelId}/readPATCHUpdate channel/api/v1/messaging/channels/{channelId}DELETEArchive channel/api/v1/messaging/channels/{channelId}GETBrowse gifs/api/v1/messaging/gifs/browseGETList gif categories/api/v1/messaging/gifs/categoriesGETSearch gifs/api/v1/messaging/gifs/searchPOSTDismiss link preview/api/v1/messaging/link-previews/{previewId}/dismissPOSTRefresh link preview/api/v1/messaging/link-previews/{previewId}/refreshGETSearch mentionable members/api/v1/messaging/mentionsPATCHEdit message/api/v1/messaging/messages/{messageId}DELETEDelete message/api/v1/messaging/messages/{messageId}GETList chat as members/api/v1/messaging/preferences/chat-as-membersGETGet chat as preference/api/v1/messaging/preferences/chat-asPUTSet chat as preference/api/v1/messaging/preferences/chat-asGETGet emoji preferences/api/v1/messaging/preferences/emojiPUTSet emoji preferences/api/v1/messaging/preferences/emojiGETGet gif preferences/api/v1/messaging/preferences/gifPUTSet gif preferences/api/v1/messaging/preferences/gifPUTSet last viewed route/api/v1/messaging/preferences/last-viewed-routePOSTReorder categories/api/v1/messaging/spaces/{spaceId}/categories/reorderGETList categories/api/v1/messaging/spaces/{spaceId}/categoriesPOSTCreate category/api/v1/messaging/spaces/{spaceId}/categoriesPOSTReorder channels/api/v1/messaging/spaces/{spaceId}/channels/reorderGETList channels/api/v1/messaging/spaces/{spaceId}/channelsPOSTCreate channel/api/v1/messaging/spaces/{spaceId}/channelsPATCHUpdate space/api/v1/messaging/spaces/{spaceId}DELETEArchive space/api/v1/messaging/spaces/{spaceId}POSTComplete space icon upload/api/v1/messaging/spaces/icon/completePOSTCreate space icon upload intent/api/v1/messaging/spaces/icon/upload-intentPOSTReorder spaces/api/v1/messaging/spaces/reorderGETList spaces/api/v1/messaging/spacesPOSTCreate space/api/v1/messaging/spacesReference shortcuts
Get messaging bootstrapSend messageList messagesGet attachment access urlSearch mentionable membersList spacesList categoriesList channelsList messages newerList messages around anchorEdit messageUnpin messageMark channel readhierarchyendpoint indexlink previewspreferencesgifserrorsobject schemaendpoints
