Skip to content
FloralityDocs
ChangelogGet an API key

Getting started

  • Quickstart
  • Authentication
  • Scopes
  • Privacy buckets
  • Rate limits
  • Errors
  • Versioning
  • Terminology
  • Webhooks PRO

Resources

  • Members
  • Groups
  • Entries
  • Front
  • Appearance
  • Custom fields
  • Trash
  • Search
  • Member statuses
  • Systems
  • Messaging
    • GETBootstrap
    • POSTSend message
    • GETList messages
    • POSTAttachments
    • GETMentions
  • Privacy buckets
  • Terminology
  • Friends
  • Subscriptions
  • Billing
  • Import
  • Social
  • Guestbook & poll
  • Group layout
  • Activity
Docs/Resources/Messaging
← PreviousSystemsNext →Privacy buckets
Florality

Organise your system. One front at a time.

Get started

Product

  • Features
  • Pricing
  • Docs
  • Changelog
  • Security

Company

  • About
  • Our team
  • Blog
  • Contact

Resources

  • FAQ
  • Trust and Safety
  • Public REST API

Legal

  • Privacy Policy
  • Terms of Service
  • Refunds and cancellation

© 2026 Florality. All rights reserved.

Florality

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.

NameTypeRequiredDescription
idstringRequiredUnique identifier.
userIdnull | stringRequiredOwning account identifier.
updatedAtnumberRequiredMost recent update time.
createdAtnumberRequiredCreation time.
deletedAtnull | numberRequiredDeletion time; null when active.
versionnumberRequiredVersion used for optimistic concurrency checks.
spaceIdstringRequiredSpace Id.
channelIdstringRequiredChannel Id.
authorUserIdstringRequiredAuthor User Id.
authorMemberIdnull | stringRequiredAuthor Member Id.
authorMemberDisplayNamenull | stringRequiredAuthor Member Display Name.
authorMemberAvatarRefnull | stringRequiredAuthor Member Avatar Ref.
messageTypestringRequiredMessage Type.
replyToMessageIdnull | stringRequiredReply To Message Id.
encryptionVersionnumberRequiredEncryption Version.
encryptionKeyIdstringRequiredEncryption Key Id.
encryptionIvstringRequiredEncryption Iv.
encryptionAuthTagstringRequiredEncryption Auth Tag.
contentFormatstringRequiredContent Format.
gifMetadataJSON valueRequiredGif Metadata.
editedAtnull | numberRequiredEdited At.
contentstringRequiredText content.
attachmentsarray<object>RequiredAttachments.
attachments[].idstringRequiredUnique identifier.
attachments[].userIdnull | stringRequiredOwning account identifier.
attachments[].createdAtnumberRequiredCreation time.
attachments[].sortOrdernumberRequiredSort Order.
attachments[].spaceIdstringRequiredSpace Id.
attachments[].messageIdstringRequiredMessage Id.
attachments[].storageRefstringRequiredStorage Ref.
attachments[].fileNamestringRequiredFile Name.
attachments[].mimeTypestringRequiredMime Type.
attachments[].byteSizenumberRequiredByte Size.
attachments[].widthnull | numberRequiredWidth.
attachments[].heightnull | numberRequiredHeight.
attachments[].durationMsnull | numberRequiredDuration Ms.
attachments[].attachmentKindstringRequiredAttachment Kind.
linkPreviewsarray<object>RequiredLink Previews.
linkPreviews[].idstringRequiredUnique identifier.
linkPreviews[].spaceIdstringRequiredSpace Id.
linkPreviews[].channelIdstringRequiredChannel Id.
linkPreviews[].messageIdstringRequiredMessage Id.
linkPreviews[].urlstringRequiredUrl.
linkPreviews[].canonicalUrlnull | stringRequiredCanonical Url.
linkPreviews[].finalUrlnull | stringRequiredFinal Url.
linkPreviews[].domainstringRequiredDomain.
linkPreviews[].siteNamenull | stringRequiredSite Name.
linkPreviews[].titlenull | stringRequiredDisplay title.
linkPreviews[].descriptionnull | stringRequiredDescription of the resource.
linkPreviews[].imageUrlnull | stringRequiredImage Url.
linkPreviews[].imageWidthnull | numberRequiredImage Width.
linkPreviews[].imageHeightnull | numberRequiredImage Height.
linkPreviews[].faviconUrlnull | stringRequiredFavicon Url.
linkPreviews[].providerNamenull | stringRequiredProvider Name.
linkPreviews[].statusstringRequiredStatus. Allowed values: "pending", "blocked", "success", "failed", "dismissed".
linkPreviews[].errorCodenull | stringRequiredError Code.
linkPreviews[].contentTypenull | stringRequiredContent Type.
linkPreviews[].httpStatusnull | numberRequiredHttp Status.
linkPreviews[].previewOrdernumberRequiredPreview Order.
linkPreviews[].fetchedAtnull | numberRequiredFetched At.
linkPreviews[].createdAtnumberRequiredCreation time.
linkPreviews[].updatedAtnumberRequiredMost recent update time.
authorMemberAvatarUrlnull | stringRequiredAuthor Member Avatar Url.
authorMemberProfileStylenull | objectRequiredAuthor Member Profile Style.
authorMemberProfileStyle.avatarRingobjectOptionalAvatar Ring.
authorMemberProfileStyle.avatarRing.showJSON valueOptionalShow.
authorMemberProfileStyle.avatarRing.colorHexJSON valueOptionalColor Hex.
authorMemberProfileStyle.avatarRing.shapeJSON valueOptionalShape.
authorMemberProfileStyle.avatarRing.gradientJSON valueOptionalGradient.
authorMemberProfileStyle.avatarRing.animationJSON valueOptionalAnimation.
authorMemberProfileStyle.avatarRing.animationSpeedJSON valueOptionalAnimation Speed.
authorMemberProfileStyle.avatarRing.strokeStyleJSON valueOptionalStroke Style.
authorMemberProfileStyle.avatarRing.customMaskStorageIdJSON valueOptionalCustom Mask Storage Id.
authorMemberProfileStyle.avatarRing.customMaskPathDJSON valueOptionalCustom Mask Path D.
authorMemberProfileStyle.bannerFrameobjectOptionalBanner Frame.
authorMemberProfileStyle.bannerFrame.colorHexJSON valueOptionalColor Hex.
authorMemberProfileStyle.bannerFrame.showBorderJSON valueOptionalShow Border.
authorMemberProfileStyle.bannerFrame.borderWidthPxJSON valueOptionalBorder Width Px.
authorMemberProfileStyle.bannerFrame.borderStyleJSON valueOptionalBorder Style.
authorMemberProfileStyle.bannerFrame.cornerStyleJSON valueOptionalCorner Style.
authorMemberProfileStyle.memberNameobjectOptionalMember Name.
authorMemberProfileStyle.memberName.fontFamilyJSON valueOptionalFont Family.
authorMemberProfileStyle.memberName.customFontIdJSON valueOptionalCustom Font Id.
authorMemberProfileStyle.memberName.colorHexJSON valueOptionalColor Hex.
authorMemberProfileStyle.memberName.gradientJSON valueOptionalGradient.
authorMemberProfileStyle.memberName.letterSpacingJSON valueOptionalLetter Spacing.
authorMemberProfileStyle.memberName.smallCapsJSON valueOptionalSmall Caps.
authorMemberProfileStyle.memberName.textShadowJSON valueOptionalText Shadow.
authorMemberProfileStyle.memberName.nameEffectJSON valueOptionalName Effect.
authorMemberProfileStyle.bannerImageobjectOptionalBanner Image.
authorMemberProfileStyle.bannerImage.brightnessJSON valueOptionalBrightness.
authorMemberProfileStyle.bannerImage.contrastJSON valueOptionalContrast.
authorMemberProfileStyle.bannerImage.tintHexJSON valueOptionalTint Hex.
authorMemberProfileStyle.bannerImage.tintOpacityJSON valueOptionalTint Opacity.
authorMemberProfileStyle.avatarImageobjectOptionalAvatar Image.
authorMemberProfileStyle.avatarImage.brightnessJSON valueOptionalBrightness.
authorMemberProfileStyle.avatarImage.contrastJSON valueOptionalContrast.
authorMemberProfileStyle.avatarImage.tintHexJSON valueOptionalTint Hex.
authorMemberProfileStyle.avatarImage.tintOpacityJSON valueOptionalTint Opacity.
authorMemberProfileStyle.bannerOverlaystringOptionalBanner Overlay. Allowed values: "none", "vignette", "soft-gradient", "film-grain", "glass-blur", "pattern-dots", "pattern-grid".
authorMemberProfileStyle.profileBackgroundPatternstringOptionalProfile Background Pattern. Allowed values: "grid", "none", "dots", "noise".
authorMemberProfileStyle.heroLayoutstringOptionalHero Layout. Allowed values: "shell-default", "avatar-centered", "avatar-left".
authorMemberProfileStyle.accentColorHexnull | stringOptionalAccent Color Hex.
authorMemberProfileStyle.profileBackgroundFillobjectOptionalProfile Background Fill.
authorMemberProfileStyle.profileBackgroundFill.modeJSON valueOptionalMode.
authorMemberProfileStyle.profileBackgroundFill.gradientJSON valueOptionalGradient.
authorMemberProfileStyle.profileBackgroundFill.solidHexJSON valueOptionalSolid Hex.
authorMemberProfileStyle.pageBackgroundFillobjectOptionalPage Background Fill. Friend-only: full Friends viewport backdrop (solid/gradient).
authorMemberProfileStyle.pageBackgroundFill.modeJSON valueOptionalMode.
authorMemberProfileStyle.pageBackgroundFill.gradientJSON valueOptionalGradient.
authorMemberProfileStyle.pageBackgroundFill.solidHexJSON valueOptionalSolid Hex.
authorMemberProfileStyle.panelBackgroundFillobjectOptionalPanel Background Fill. Friend-only: profile card panel fill (free: preset solids; Pro+: custom solid/gradient).
authorMemberProfileStyle.panelBackgroundFill.modeJSON valueOptionalMode.
authorMemberProfileStyle.panelBackgroundFill.gradientJSON valueOptionalGradient.
authorMemberProfileStyle.panelBackgroundFill.solidHexJSON valueOptionalSolid Hex.
authorMemberProfileStyle.panelFillAccentHexnull | stringOptionalPanel Fill Accent Hex. Friend-only: optional accent mixed into the profile panel backdrop (Pro+).
authorMemberProfileStyle.panelCardAccentHexnull | stringOptionalPanel Card Accent Hex. Friend-only: optional accent mixed into section cards (Pro+).
authorMemberSystemTagnull | objectRequiredAuthor Member System Tag.
authorMemberSystemTag.namestringRequiredName of the resource.
authorMemberSystemTag.codestringRequiredCode.
authorMemberSystemTag.colorstringRequiredColor.
authorMemberSystemTag.iconstringOptionalIcon.
replyTonull | objectRequiredReply To.
replyTo.idstringRequiredUnique identifier.
replyTo.authorMemberIdnull | stringRequiredAuthor Member Id.
replyTo.authorMemberDisplayNamenull | stringRequiredAuthor Member Display Name.
replyTo.authorMemberAvatarUrlnull | stringRequiredAuthor Member Avatar Url.
replyTo.authorMemberProfileStylenull | objectRequiredAuthor Member Profile Style.
replyTo.authorMemberProfileStyle.avatarRingJSON valueOptionalAvatar Ring.
replyTo.authorMemberProfileStyle.bannerFrameJSON valueOptionalBanner Frame.
replyTo.authorMemberProfileStyle.memberNameJSON valueOptionalMember Name.
replyTo.authorMemberProfileStyle.bannerImageJSON valueOptionalBanner Image.
replyTo.authorMemberProfileStyle.avatarImageJSON valueOptionalAvatar Image.
replyTo.authorMemberProfileStyle.bannerOverlayJSON valueOptionalBanner Overlay.
replyTo.authorMemberProfileStyle.profileBackgroundPatternJSON valueOptionalProfile Background Pattern.
replyTo.authorMemberProfileStyle.heroLayoutJSON valueOptionalHero Layout.
replyTo.authorMemberProfileStyle.accentColorHexJSON valueOptionalAccent Color Hex.
replyTo.authorMemberProfileStyle.profileBackgroundFillJSON valueOptionalProfile Background Fill.
replyTo.authorMemberProfileStyle.pageBackgroundFillJSON valueOptionalPage Background Fill. Friend-only: full Friends viewport backdrop (solid/gradient).
replyTo.authorMemberProfileStyle.panelBackgroundFillJSON valueOptionalPanel Background Fill. Friend-only: profile card panel fill (free: preset solids; Pro+: custom solid/gradient).
replyTo.authorMemberProfileStyle.panelFillAccentHexJSON valueOptionalPanel Fill Accent Hex. Friend-only: optional accent mixed into the profile panel backdrop (Pro+).
replyTo.authorMemberProfileStyle.panelCardAccentHexJSON valueOptionalPanel Card Accent Hex. Friend-only: optional accent mixed into section cards (Pro+).
replyTo.authorMemberSystemTagnull | objectRequiredAuthor Member System Tag.
replyTo.authorMemberSystemTag.namestringRequiredName of the resource.
replyTo.authorMemberSystemTag.codestringRequiredCode.
replyTo.authorMemberSystemTag.colorstringRequiredColor.
replyTo.authorMemberSystemTag.iconJSON valueOptionalIcon.
replyTo.snippetstringRequiredSnippet.
replyTo.deletedAtnull | numberRequiredDeletion time; null when active.
mentionsarray<object>RequiredMentions.
mentions[].typestringRequiredType. Allowed values: "dynamic", "member".
mentions[].idstringRequiredUnique identifier.
mentions[].labelstringRequiredLabel.
mentions[].hrefnull | stringRequiredHref.
mentions[].isVisiblebooleanRequiredIs Visible.
mentions[].fallbackReasonstringOptionalFallback Reason. Allowed values: "unknown", "hidden", "deleted".
encryptedContentstringRequiredEncrypted 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/spaces

Reference 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