Documentation

This is taking longer than usual. If nothing appears, refresh the page.

Documentation

    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

Connect an AI assistant

Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.

The catalog did not load. Refresh the page to try again.

Loading…

How can we help?

{{docApp.searchError}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

 {{docApp.currentResultsSearchText}}  in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown. Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

  • {{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}

    {{resultItem.url}}

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

/ activity / activityPostMessage

  • Article
  • 2 minutes to read

Description

Posts an update to the specified activity stream. The activity stream must exist.

API Details

  • Status:
  • The required privilege level to invoke this method is user
  • The supported database role for this method is none
  • Transactional database functions are used during this method when supported by the target database.
System Rights Database Rights Mail Rights Calendar Rights
sys.e.postMessage
 --- --- ---

Request Parameters

The activityPostMessage method takes the following input parameters.

Note

When sending a JSON request payload to the API, the order of parameters is not significant. However, for XML request payloads, parameters must be provided in the exact order specified in this documentation to comply with input validation requirements.

Name Type Attributes Description
activityStreamID xs:anyURI Required The ID of the activity stream you are posting a message to.
content xs:string Required The status update text.
language xs:language Optional If you are posting the update in a language other than your current language then you should specify the language code here. If not specified then your current language will be assumed
extra xs:string Optional An arbitary string value, could be a JSON/XML/Other undocumented (here) structure defined by the front end devs, representing additional content for the message.
visibility activityVisibilityType Optional
Default=following		 The visibility of this activity.
location geoLocationType Optional You can specify a geographical location to associate to this activity.
type xs:string Optional The type of activity. When querying activities this can be used to filter activities
objectRefUrn xs:anyURI Optional The urn of the object associated with this activity
activityType activityType Optional The type of the activity
attachLocalFile Array<embeddedFileAttachmentType> Optional The files to attach. Use this type if you are embedding the file content within this API call
attachServerFile Array<serverFileAttachmentType> Optional The files to attach. Use this type if you the file content is accessible to the server, for example a temporary file on the session folder
supressFollowerNotification xs:boolean Optional
Default=false		 You can supress follower notifications for this post, useful when adding content to the activity stream where the user does not need to be notified

Response Parameters

Name Type Attributes Description
activity buzzActivityType Required The posted message
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document