> For the complete documentation index, see [llms.txt](https://api-docs.myhappyforce.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://api-docs.myhappyforce.com/docs/api-reference/announcements-configuration-resource.md).

# Announcements Configuration Resource

## GET /api/v1/company/announcements/configuration

>

```json
{"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"tags":[],"servers":[{"url":"{url}","description":"API URL","variables":{"url":{"description":"API Environment","enum":["https://api.happyforce.com","https://staging.happyforce.com","http://localhost:9000"],"default":"https://api.happyforce.com"}}}],"security":[{"companyAPISessionId":[]}],"components":{"securitySchemes":{"companyAPISessionId":{"type":"apiKey","description":"SessionId","name":"SessionId","in":"header"}},"schemas":{"AnnouncementsConfigurationDTO":{"type":"object","description":"Wrapper DTO for sending and receiving the list of announcement section configurations","properties":{"sections":{"description":"List of section configuration elements","oneOf":[{"$ref":"#/components/schemas/AnnouncementCommentReplySectionConfig"},{"$ref":"#/components/schemas/AnnouncementDefaultSectionConfig"},{"$ref":"#/components/schemas/AnnouncementLifeEventsSectionConfig"},{"$ref":"#/components/schemas/AnnouncementRecognitionsSectionConfig"},{"$ref":"#/components/schemas/AnnouncementUnreadSectionConfig"}]}},"required":["sections"]},"AnnouncementCommentReplySectionConfig":{"allOf":[{"$ref":"#/components/schemas/AnnouncementSectionConfigBase"}],"required":["title"]},"AnnouncementSectionConfigBase":{"type":"object","description":"List of section configuration elements","discriminator":{"propertyName":"id"},"properties":{"title":{"$ref":"#/components/schemas/MultiLanguage"},"removable":{"type":"boolean"},"id":{"type":"string"},"layout":{"type":"string","enum":["HORIZONTAL","VERTICAL","HTML"]},"generated":{"type":"boolean"},"representation":{"type":"string","enum":["COVER","STANDARD"]},"searchEnabled":{"type":"boolean"},"deletionCapable":{"type":"boolean"},"publishingCapable":{"type":"boolean"},"archivableCapable":{"type":"boolean"},"onlyInApp":{"type":"boolean"},"listingType":{"type":"string","enum":["STANDARD","DATE_GROUPS","DIRECT"]}},"required":["title"]},"MultiLanguage":{"type":"object","description":"A translatable text value: a required default value plus optional per-language overrides keyed by language tag (e.g. \"es\", \"en\", \"pt-BR\"). Consumers resolve the user's language from langValues (falling back to the base language, then to defaultValue).","properties":{"defaultValue":{"type":"string","description":"Fallback text used when there is no entry in langValues for the requested language.","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"},"description":"Per-language overrides keyed by language tag (e.g. \"es\", \"en\", \"pt-BR\")."},"valid":{"type":"boolean"}},"required":["defaultValue"]},"AnnouncementDefaultSectionConfig":{"allOf":[{"$ref":"#/components/schemas/AnnouncementSectionConfigBase"}],"required":["title"]},"AnnouncementLifeEventsSectionConfig":{"allOf":[{"$ref":"#/components/schemas/AnnouncementSectionConfigBase"},{"type":"object","properties":{"eventTypeConfigurations":{"type":"array","items":{"$ref":"#/components/schemas/EventTypeTemplateConfiguration"}}}}],"required":["title"]},"EventTypeTemplateConfiguration":{"type":"object","properties":{"eventType":{"type":"string","enum":["BIRTH_ANNIVERSARY","BIRTHDAY","WORK_ANNIVERSARY","START_DATE"]},"title":{"$ref":"#/components/schemas/MultiLanguage"},"message":{"$ref":"#/components/schemas/MultiLanguage"},"enabled":{"type":"boolean"},"allowComments":{"type":"boolean"},"allowLikes":{"type":"boolean"}}},"AnnouncementRecognitionsSectionConfig":{"allOf":[{"$ref":"#/components/schemas/AnnouncementSectionConfigBase"},{"type":"object","properties":{"monthsToShow":{"type":"integer","format":"int32"},"minRecognitions":{"type":"integer","format":"int32"},"allowComments":{"type":"boolean"},"allowLikes":{"type":"boolean"}}}],"required":["title"]},"AnnouncementUnreadSectionConfig":{"allOf":[{"$ref":"#/components/schemas/AnnouncementSectionConfigBase"},{"type":"object","properties":{"elapsedDaysLessThan":{"type":"integer","format":"int32"}}}],"required":["title"]}}},"paths":{"/api/v1/company/announcements/configuration":{"get":{"tags":["announcements-configuration-resource"],"operationId":"getAnnouncementsConfiguration","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AnnouncementsConfigurationDTO"}}}}}}}}}
```

## PUT /api/v1/company/announcements/configuration

>

```json
{"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"tags":[],"servers":[{"url":"{url}","description":"API URL","variables":{"url":{"description":"API Environment","enum":["https://api.happyforce.com","https://staging.happyforce.com","http://localhost:9000"],"default":"https://api.happyforce.com"}}}],"security":[{"companyAPISessionId":[]}],"components":{"securitySchemes":{"companyAPISessionId":{"type":"apiKey","description":"SessionId","name":"SessionId","in":"header"}},"schemas":{"AnnouncementsConfigurationDTO":{"type":"object","description":"Wrapper DTO for sending and receiving the list of announcement section configurations","properties":{"sections":{"description":"List of section configuration elements","oneOf":[{"$ref":"#/components/schemas/AnnouncementCommentReplySectionConfig"},{"$ref":"#/components/schemas/AnnouncementDefaultSectionConfig"},{"$ref":"#/components/schemas/AnnouncementLifeEventsSectionConfig"},{"$ref":"#/components/schemas/AnnouncementRecognitionsSectionConfig"},{"$ref":"#/components/schemas/AnnouncementUnreadSectionConfig"}]}},"required":["sections"]},"AnnouncementCommentReplySectionConfig":{"allOf":[{"$ref":"#/components/schemas/AnnouncementSectionConfigBase"}],"required":["title"]},"AnnouncementSectionConfigBase":{"type":"object","description":"List of section configuration elements","discriminator":{"propertyName":"id"},"properties":{"title":{"$ref":"#/components/schemas/MultiLanguage"},"removable":{"type":"boolean"},"id":{"type":"string"},"layout":{"type":"string","enum":["HORIZONTAL","VERTICAL","HTML"]},"generated":{"type":"boolean"},"representation":{"type":"string","enum":["COVER","STANDARD"]},"searchEnabled":{"type":"boolean"},"deletionCapable":{"type":"boolean"},"publishingCapable":{"type":"boolean"},"archivableCapable":{"type":"boolean"},"onlyInApp":{"type":"boolean"},"listingType":{"type":"string","enum":["STANDARD","DATE_GROUPS","DIRECT"]}},"required":["title"]},"MultiLanguage":{"type":"object","description":"A translatable text value: a required default value plus optional per-language overrides keyed by language tag (e.g. \"es\", \"en\", \"pt-BR\"). Consumers resolve the user's language from langValues (falling back to the base language, then to defaultValue).","properties":{"defaultValue":{"type":"string","description":"Fallback text used when there is no entry in langValues for the requested language.","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"},"description":"Per-language overrides keyed by language tag (e.g. \"es\", \"en\", \"pt-BR\")."},"valid":{"type":"boolean"}},"required":["defaultValue"]},"AnnouncementDefaultSectionConfig":{"allOf":[{"$ref":"#/components/schemas/AnnouncementSectionConfigBase"}],"required":["title"]},"AnnouncementLifeEventsSectionConfig":{"allOf":[{"$ref":"#/components/schemas/AnnouncementSectionConfigBase"},{"type":"object","properties":{"eventTypeConfigurations":{"type":"array","items":{"$ref":"#/components/schemas/EventTypeTemplateConfiguration"}}}}],"required":["title"]},"EventTypeTemplateConfiguration":{"type":"object","properties":{"eventType":{"type":"string","enum":["BIRTH_ANNIVERSARY","BIRTHDAY","WORK_ANNIVERSARY","START_DATE"]},"title":{"$ref":"#/components/schemas/MultiLanguage"},"message":{"$ref":"#/components/schemas/MultiLanguage"},"enabled":{"type":"boolean"},"allowComments":{"type":"boolean"},"allowLikes":{"type":"boolean"}}},"AnnouncementRecognitionsSectionConfig":{"allOf":[{"$ref":"#/components/schemas/AnnouncementSectionConfigBase"},{"type":"object","properties":{"monthsToShow":{"type":"integer","format":"int32"},"minRecognitions":{"type":"integer","format":"int32"},"allowComments":{"type":"boolean"},"allowLikes":{"type":"boolean"}}}],"required":["title"]},"AnnouncementUnreadSectionConfig":{"allOf":[{"$ref":"#/components/schemas/AnnouncementSectionConfigBase"},{"type":"object","properties":{"elapsedDaysLessThan":{"type":"integer","format":"int32"}}}],"required":["title"]}}},"paths":{"/api/v1/company/announcements/configuration":{"put":{"tags":["announcements-configuration-resource"],"operationId":"updateAnnouncementsConfiguration","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/AnnouncementsConfigurationDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AnnouncementsConfigurationDTO"}}}}}}}}}
```

## GET /api/v1/company/announcements/configuration/default

>

```json
{"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"tags":[],"servers":[{"url":"{url}","description":"API URL","variables":{"url":{"description":"API Environment","enum":["https://api.happyforce.com","https://staging.happyforce.com","http://localhost:9000"],"default":"https://api.happyforce.com"}}}],"security":[{"companyAPISessionId":[]}],"components":{"securitySchemes":{"companyAPISessionId":{"type":"apiKey","description":"SessionId","name":"SessionId","in":"header"}},"schemas":{"AnnouncementsConfigurationDTO":{"type":"object","description":"Wrapper DTO for sending and receiving the list of announcement section configurations","properties":{"sections":{"description":"List of section configuration elements","oneOf":[{"$ref":"#/components/schemas/AnnouncementCommentReplySectionConfig"},{"$ref":"#/components/schemas/AnnouncementDefaultSectionConfig"},{"$ref":"#/components/schemas/AnnouncementLifeEventsSectionConfig"},{"$ref":"#/components/schemas/AnnouncementRecognitionsSectionConfig"},{"$ref":"#/components/schemas/AnnouncementUnreadSectionConfig"}]}},"required":["sections"]},"AnnouncementCommentReplySectionConfig":{"allOf":[{"$ref":"#/components/schemas/AnnouncementSectionConfigBase"}],"required":["title"]},"AnnouncementSectionConfigBase":{"type":"object","description":"List of section configuration elements","discriminator":{"propertyName":"id"},"properties":{"title":{"$ref":"#/components/schemas/MultiLanguage"},"removable":{"type":"boolean"},"id":{"type":"string"},"layout":{"type":"string","enum":["HORIZONTAL","VERTICAL","HTML"]},"generated":{"type":"boolean"},"representation":{"type":"string","enum":["COVER","STANDARD"]},"searchEnabled":{"type":"boolean"},"deletionCapable":{"type":"boolean"},"publishingCapable":{"type":"boolean"},"archivableCapable":{"type":"boolean"},"onlyInApp":{"type":"boolean"},"listingType":{"type":"string","enum":["STANDARD","DATE_GROUPS","DIRECT"]}},"required":["title"]},"MultiLanguage":{"type":"object","description":"A translatable text value: a required default value plus optional per-language overrides keyed by language tag (e.g. \"es\", \"en\", \"pt-BR\"). Consumers resolve the user's language from langValues (falling back to the base language, then to defaultValue).","properties":{"defaultValue":{"type":"string","description":"Fallback text used when there is no entry in langValues for the requested language.","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"},"description":"Per-language overrides keyed by language tag (e.g. \"es\", \"en\", \"pt-BR\")."},"valid":{"type":"boolean"}},"required":["defaultValue"]},"AnnouncementDefaultSectionConfig":{"allOf":[{"$ref":"#/components/schemas/AnnouncementSectionConfigBase"}],"required":["title"]},"AnnouncementLifeEventsSectionConfig":{"allOf":[{"$ref":"#/components/schemas/AnnouncementSectionConfigBase"},{"type":"object","properties":{"eventTypeConfigurations":{"type":"array","items":{"$ref":"#/components/schemas/EventTypeTemplateConfiguration"}}}}],"required":["title"]},"EventTypeTemplateConfiguration":{"type":"object","properties":{"eventType":{"type":"string","enum":["BIRTH_ANNIVERSARY","BIRTHDAY","WORK_ANNIVERSARY","START_DATE"]},"title":{"$ref":"#/components/schemas/MultiLanguage"},"message":{"$ref":"#/components/schemas/MultiLanguage"},"enabled":{"type":"boolean"},"allowComments":{"type":"boolean"},"allowLikes":{"type":"boolean"}}},"AnnouncementRecognitionsSectionConfig":{"allOf":[{"$ref":"#/components/schemas/AnnouncementSectionConfigBase"},{"type":"object","properties":{"monthsToShow":{"type":"integer","format":"int32"},"minRecognitions":{"type":"integer","format":"int32"},"allowComments":{"type":"boolean"},"allowLikes":{"type":"boolean"}}}],"required":["title"]},"AnnouncementUnreadSectionConfig":{"allOf":[{"$ref":"#/components/schemas/AnnouncementSectionConfigBase"},{"type":"object","properties":{"elapsedDaysLessThan":{"type":"integer","format":"int32"}}}],"required":["title"]}}},"paths":{"/api/v1/company/announcements/configuration/default":{"get":{"tags":["announcements-configuration-resource"],"operationId":"getDefaultConfigurationForSectionType","parameters":[{"name":"sectionTypeId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AnnouncementsConfigurationDTO"}}}}}}}}}
```
