> ## Documentation Index > Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt > Use this file to discover all available pages before exploring further. # Post News Feed Item > Saves a new item to the newsfeed, publishing it to the specified users. NsApiSlow threshold: 2000 ms. ## Experimental: ## The NewsFeed agent is experimental, subject to change, and not intended for partners. ## OpenAPI ````yaml /openapi/agent/openapi-v3-NewsFeedAgent.json post /api/v1/Agents/NewsFeed/PostNewsFeedItem openapi: 3.0.0 info: version: v1-Agents title: SuperOffice Agent API v1 description: SuperOffice Agent API - NewsFeedAgent contact: name: SuperOffice DevNet url: https://docs.superoffice.com/en/api/index.html email: sdk@superoffice.com servers: - url: http://localhost:56350 - url: https://localhost:56350 security: [] tags: [] externalDocs: description: >- The SuperOffice DevNet Community has more documentation, examples, and discussion forums. url: https://community.superoffice.com/en/developer/ paths: /api/v1/Agents/NewsFeed/PostNewsFeedItem: post: tags: - NewsFeed_Agent summary: Post News Feed Item description: "Saves a new item to the newsfeed, publishing it to the specified users.\n\nNsApiSlow threshold: 2000 ms.\r\n## Experimental: ## The NewsFeed agent is experimental, subject to change, and not intended for partners." operationId: v1NewsFeedAgent_PostNewsFeedItem parameters: - name: $select in: query description: >- Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields. required: false schema: type: string - name: Accept-Language in: header description: >- Convert string references and multi-language values into a specified language (iso2) code. required: false schema: type: string - name: SO-Language in: header description: >- Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value. required: false schema: type: string - name: SO-Culture in: header description: >- Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set. required: false schema: type: string - name: SO-TimeZone in: header description: >- Specify the timezone code that you would like date/time responses converted to. required: false schema: type: string - name: SO-AppToken in: header description: >- The application token that identifies the partner app. Used when calling Online WebAPI from a server. required: false schema: type: string requestBody: content: application/json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.NewsFeedCarriers.PostNewsFeedItemRequest text/json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.NewsFeedCarriers.PostNewsFeedItemRequest application/xml: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.NewsFeedCarriers.PostNewsFeedItemRequest text/xml: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.NewsFeedCarriers.PostNewsFeedItemRequest application/x-www-form-urlencoded: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.NewsFeedCarriers.PostNewsFeedItemRequest application/json-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.NewsFeedCarriers.PostNewsFeedItemRequest application/merge-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.NewsFeedCarriers.PostNewsFeedItemRequest description: NewsFeedItem, ToAssociateIds, ToGroupIds, ToAll required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.NewsFeedItem' text/json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.NewsFeedItem' application/xml: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.NewsFeedItem' text/xml: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.NewsFeedItem' application/json-patch+json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.NewsFeedItem' application/merge-patch+json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.NewsFeedItem' security: - SuperOffice_Password: [] SuperId_Authentication: [] components: schemas: SuperOffice.WebApi.v1.Carriers.NewsFeedCarriers.PostNewsFeedItemRequest: description: >- PostNewsFeedItem: Saves a new item to the newsfeed, publishing it to the specified users. type: object properties: NewsFeedItem: $ref: '#/components/schemas/SuperOffice.CRM.Services.NewsFeedItem' ToAssociateIds: type: array items: format: int32 type: integer ToGroupIds: type: array items: format: int32 type: integer ToAll: type: boolean SuperOffice.CRM.Services.NewsFeedItem: description: "News feed items are created by agents or other services for display on the start page and other relevant places in the UI.\r\n\r\nCarrier object for NewsFeedItem.\r\nServices for the NewsFeedItem Carrier is available from the NewsFeed Agent." type: object properties: NewsFeedItemId: format: int32 description: Primary key type: integer Title: description: >- Short, descriptive headline. Plain text title. Multi-language string supported: 'US:"english";NO:"norsk"'. type: string Summary: description: >- Short, descriptive summary. Plain text summary. Multi-language string supported: 'US:"english";NO:"norsk"'. type: string Description: description: >- Multi-language descriptions for the news feed item, where the key is an ISO 2 letter language code (e.g. 'en', 'no', 'de') and the value is the description in that language. Styling via pre-defined CSS classes. No SCRIPT or STYLE tags allowed. The 'current' value is set based on the Accept-Language/SO-Language header. type: object additionalProperties: type: string Actions: description: >- Call to action items for the news feed item. Each item contains a title, an identifier, a type and flavor. type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.NewsFeedCTA' ImageLink: description: URL Link to an image associated with the news item. type: string SourceLink: description: >- URL Link to the source of the news item, or an SOProtocol link to a SuperOffice item type: string PreviewHint: description: Preview hint for the news item. e.g. `{contact_id=123}` type: string FromName: description: >- Name of the instance that published this item. e.g. `Pete the prospector` type: string FromCategoryName: description: >- Type of the instance that published this item. e.g. `Prospector Agent` type: string Priority: description: >- Importance of the news item. Low to High. Higher priority items may be shown more prominently in the feed. enum: - NoPriority - Highest - High - Normal - Low - Lowest type: string Registered: format: date-time description: Registered when in UTC. type: string Updated: format: date-time description: Last updated when in UTC. type: string ExpiresAt: format: date-time description: >- When the news item expires and should no longer be shown in feeds (UTC) in UTC. type: string Status: description: >- Indicates if the item is being handled by a CTA. (normal, processing, processed) enum: - Normal - Handling - Handled type: string IsRead: description: Set to true when the recipient user has read the news feed item. type: boolean ReadAt: format: date-time description: When the recipient user read the news feed item (UTC) in UTC. type: string Contact: $ref: '#/components/schemas/SuperOffice.CRM.Services.Contact' Person: $ref: '#/components/schemas/SuperOffice.CRM.Services.Person' Project: $ref: '#/components/schemas/SuperOffice.CRM.Services.Project' Sale: $ref: '#/components/schemas/SuperOffice.CRM.Services.Sale' ApplicationId: description: >- The id of the application that registered this news item. Used to resolve where any CTA should be posted when clicked. type: string Location: description: Place related to news item (city or city + country) (optional) type: string RatingPercent: format: int32 description: >- Rating as percentage (0-100). 0 = undefined. 1-9 = No stars, 10-30 = One star, Two stars = 31-50, 90-100 = Five stars. Client can render rating as stars, pie chart, thumbs up or down, however they want. Default 0 indicates no rating. type: integer SuperOffice.CRM.Services.NewsFeedCTA: description: "News feed CTAs are created by agents or other services for display on the start page and other relevant places in the UI.\r\n\r\nCarrier object for NewsFeedCTA.\r\nServices for the NewsFeedCTA Carrier is available from the NewsFeed Agent." type: object properties: Identifier: description: >- An identifier for the CTA, which will be sent back to the application when the user clicks the CTA button. E.g. 'approve_button/234', 'reject/53fw1', '5235faq143='. Where to route is determined by the ApplicationId on the NewsFeedItem type: string Title: description: >- The title of the CTA button. E.g. 'Approve', 'Reject', 'View details'. Multi-language string supported: 'US:"english";NO:"norsk"'. type: string CtaType: description: >- The type of the CTA, which determines how the CTA button renders. Primary/Secondary/Link enum: - Unknown - Primary - Secondary - Link type: string CtaFlavor: description: >- The flavor of the CTA, which determines the style/color/icon the CTA button renders with. Info/Warning/Error/Accept/Reject enum: - Normal - Info - Warning - Error - Accept - Reject type: string SuperOffice.CRM.Services.Contact: description: "Carrier object for Contact.\r\nServices for the Contact Carrier is available from the Contact Agent." type: object properties: ContactId: format: int32 description: Primary key type: integer Name: description: Contact name type: string OrgNr: description: VAT number or similar type: string Department: description: Department type: string URL: description: The internet address to this contact type: string City: description: City corresponding to zip code type: string DirectPhone: description: The contacts phone type: string AssociateId: format: int32 description: Our contact type: integer CountryId: format: int32 description: Country type: integer EmailAddress: description: The contact email address type: string Kananame: description: Contact kana name, used in Japanese versions only type: string EmailAddressName: description: Visible field type: string URLName: description: Visible field type: string AssociateFullName: description: >- The associate's culture formatted fullname (firstname, middleName and lastname) type: string BusinessName: description: The business list item name type: string CategoryName: description: The category list item name type: string CountryName: description: Name of country in installed language type: string Address: $ref: '#/components/schemas/SuperOffice.CRM.Services.Address' FormattedAddress: description: >- The contact's address, formatted with linebreaks and spaces into a single string. type: string FullName: description: '' type: string IsOwnerContact: description: >- Is the contact an owner contact. This means that all persons on this contact can on only be internal users and not external users. type: boolean ActiveErpLinks: format: int32 description: The number of active erp links type: integer Number1: description: Alphanumeric user field type: string Number2: description: Alphanumeric user field type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.Person: description: "Carrier object for Person.\r\nServices for the Person Carrier is available from the Person Agent." type: object properties: Position: description: >- The position. This is a predefined SuperOffice value, different from Title type: string PersonId: format: int32 description: Primary key type: integer Mrmrs: description: e.g. Mrs sex_title type: string Firstname: description: First name type: string Lastname: description: Last name type: string MiddleName: description: Middle name or 'van' etc. type: string Title: description: Title type: string Description: description: Info text/description on person. type: string Email: description: First email on contact person. type: string FullName: description: >- Get the persons full name (internal name used in clients for employees). type: string DirectPhone: description: Returns the direct phone that belong to the contact person. type: string FormalName: description: >- Get formal name for a person, as used in labels. (Full name + person title + academic title) type: string CountryId: format: int32 description: Country type: integer ContactId: format: int32 description: Owning contact ID type: integer ContactName: description: The persons company name type: string Retired: format: int32 description: >- 1 = the user is retired and should have no rights, not appear in lists, etc. type: integer Rank: format: int32 description: Display sort sequence for default sort order type: integer ActiveInterests: format: int32 description: >- Number of records in pintr table; select count(*) from pintr pi where pi.person_id = this.person_id == activeInterests is always true type: integer ContactDepartment: description: The persons contact department type: string ContactCountryId: format: int32 description: The persons contact country id type: integer ContactOrgNr: description: The persons contact organization number type: string FaxPhone: description: Returns the fax phone that belong to the contact person. type: string MobilePhone: description: Returns the mobile phone that belong to the contact person. type: string ContactPhone: description: Returns the direct phone that belong to the persons contact. type: string AssociateName: description: Name of the person's owner type: string AssociateId: format: int32 description: Id of the item's owner (Associate id) type: integer UsePersonAddress: description: If 1, use person's address for mailing instead of company address type: boolean ContactFax: description: Actual phone number as eneterd by the user type: string Kanafname: description: Kana first name, used in Japanese versions only type: string Kanalname: description: Kana last name, used in Japanese versions only type: string Post1: description: Postal address, used in Japanese versions only type: string Post2: description: Postal address, used in Japanese versions only type: string Post3: description: Postal address, used in Japanese versions only type: string EmailName: description: E-mail description type: string ContactFullName: description: Company full name + department type: string ActiveErpLinks: format: int32 description: How many active ERP links are there for this person? type: integer TicketPriorityId: format: int32 description: Ticket priority ID type: integer SupportLanguageId: format: int32 description: Support priority ID type: integer SupportAssociateId: format: int32 description: Our support contact for this person type: integer CategoryName: description: The category list item name type: string PersonNumber: description: Alphanumeric user field type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.Project: description: "Carrier object for Project.\r\nServices for the Project Carrier is available from the Project Agent." type: object properties: ProjectId: format: int32 description: Primary key type: integer Name: description: Project name type: string Description: description: The projects description type: string URL: description: URL address type: string Type: description: The project type. type: string AssociateId: format: int32 description: The project owner id (associate id) type: integer AssociateFullName: description: The project owner type: string TypeId: format: int32 description: '' type: integer Updated: format: date-time description: Last updated date in UTC. type: string StatusId: format: int32 description: The projects status id type: integer Status: description: The projects status type: string TextId: format: int32 description: The id of the description type: integer PublishTo: format: date-time description: Publication valid to (inclusive) type: string PublishFrom: format: date-time description: Publication valid from (inclusive) type: string IsPublished: description: '' type: boolean URLName: description: Visible field type: string ProjectNumber: description: Automatically generated number type: string ActiveErpLinks: format: int32 description: The number of active erp links type: integer EventId: format: int32 description: Reserved field for Lyyti event when project is linked to an event. type: integer StartDate: format: date-time description: >- Reserved field for Lyyti event when project is linked to an event, is the event start date. type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.Sale: description: "Carrier object for Sale.\r\nServices for the Sale Carrier is available from the Sale Agent." type: object properties: ContactName: description: Contact name type: string SaleDate: format: date-time description: (expected / lost / won) sales date type: string SaleId: format: int32 description: Primary key type: integer Probability: format: int32 description: Actual probability, may differ from the one in the list type: integer Title: description: Sale heading (short description?) type: string Amount: format: double description: Total sale amount type: number Currency: description: Currency the sale was made in. type: string ProjectName: description: Project name type: string AssociateFullName: description: The sale's owner type: string Description: description: The sales description type: string Status: description: The sale's status, indicating wether the sale is open, sold or lost. enum: - Unknown - Open - Sold - Lost - Stalled - SaintAll type: string WeightedAmount: format: double description: The weighted amount ( amount * probability / 100) type: number ProjectId: format: int32 description: Optional project reference type: integer EarningPercent: format: double description: Earning as percent of total type: number Earning: format: double description: Earning on sale type: number ContactId: format: int32 description: Optional contact reference type: integer AssociateId: format: int32 description: The sale's owner id type: integer PersonId: format: int32 description: The sale's contact persons id type: integer SaleTypeId: format: int32 description: The sale's type id type: integer SaleTypeName: description: The sale's type name type: string PersonFullName: description: The name of the person this sale belongs to. type: string Completed: description: >- The Sale completed state. The completed state is either Started or Completed. NotStarted is treated as Started. The value maps to the Done database field. enum: - Unknown - NotStarted - Started - Completed type: string ActiveErpLinks: format: int32 description: The number of active erp links type: integer NextDueDate: format: date-time description: >- Next due date, this is a denormalization of 'closest future activity date, or most recent if no future activities'. Maintained by the system, but very convenient for searching. type: string Number: description: Alphanumeric user field type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.Address: description: "Street and/or Postal address, in both formatted and structured forms. You only need to modify one of the two for the change to be registered.\r\n\r\nCarrier object for Address." type: object properties: Wgs84Latitude: format: double description: >- Latitude (that's north/south), decimal degrees, relative to WGS 84 ellipsoid. SuperOffice ASA is at 59.91892. This value needs no further grid reference or other qualifying information. type: number Wgs84Longitude: format: double description: >- Longitude (that's East/west), decimal degrees, relative to WGS 84 ellipsoid. SuperOffice ASA is at 10.73159. This value needs no further grid reference or other qualifying information. type: number LocalizedAddress: description: >- LocalizedFieldArray is a list of LocalizedFieldList objects. Used to store localized information such as formatted address data. type: array items: type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.LocalizedField' Street: $ref: '#/components/schemas/SuperOffice.CRM.Services.StructuredAddress' Postal: $ref: '#/components/schemas/SuperOffice.CRM.Services.StructuredAddress' Formatted: description: >- Read-only formatted address multi-line string. Combines street and postal into one string. e.g.: "Postboks 123,\nBrugata 123,\n1234 OSLO\n" or "Postbox 123,\nBridgelane 123,\nWest Tooting,\nEast Shire ES2 W31\n". type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Security.TableRight: description: "Wraps a table right together with an explanatory reason.\r\nCode can indicate why access is restricted." type: object properties: Mask: type: string Reason: type: string SuperOffice.CRM.Security.FieldProperty: description: >- Class holding properties like field length, field type about a field in the carrier. type: object properties: FieldRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldRight' FieldType: type: string FieldLength: format: int32 description: '' type: integer SuperOffice.CRM.Services.LocalizedField: description: "LocalizedField is used to store localized information such as formatted address data, a formatted phone number, etc.\r\n\r\nCarrier object for LocalizedField." type: object properties: Name: description: Name of the value field type: string Value: description: The field's value type: string Tooltip: description: The tooltip type: string Label: description: The label of the field type: string ValueLength: format: int32 description: Database length of the value type: integer AddressType: description: '' type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.StructuredAddress: description: "Address with structured fields (Address1, City, Zip) - does not vary its layout by country, unliked the formatted address.\r\n\r\nCarrier object for StructuredAddress." type: object properties: AtypeIdx: description: >- Bit mask, combines address type (EAddressType) and owner type (EOwnerType) enum: - Unknown - ContactPostalAddress - ContactStreetAddress - PersonPrivateAddress - QuoteBillingAddress - QuoteShippingAddress type: string Address1: description: Address line 1 type: string Address2: description: Address line 2 type: string Address3: description: Address line 3 type: string City: description: City corresponding to zip code type: string County: description: County (not country) type: string State: description: State type: string Zipcode: description: Zip code, alphanumeric type: string Formatted: description: >- Read-only formatted address multi-line string. e.g.: "Brugata 123,\n1234 OSLO\n" or "Bridgelane 123,\nWest Tooting,\nThe Shire ES2 W31\n". type: string SuperOffice.CRM.Security.FieldRight: description: "Wraps the field right together with an explanatory reason.\r\nAlso adds logical operators to the field rights so that they can be easily combined." type: object properties: Mask: type: string Reason: type: string ```` ## Related topics - [Post News Feed Item](/en/api/reference/restful/rest/newsfeeditem/post-news-feed-item.md) - [SuperOffice.WebApi.Data.NewsFeed PostNewsFeedItemRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.NewsFeed_PostNewsFeedItemRequest.md) - [SuperOffice.WebApi.Agents.NewsFeedAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.NewsFeedAgent.md) - [SuperOffice.WebApi.Agents.INewsFeedAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.INewsFeedAgent.md) - [WebAPI changes in SuperOffice 12.2](/release-notes/12/api/changes-webapi-12.2.2072.0.md) - [NewsFeedItem](/en/api/archive-providers/reference/newsfeeditem.md)