> 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-resource.md).

# Announcements Resource

## PUT /api/v1/company/announcements/{announcementId}

>

```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":{"LifeEventAnnouncementCreateUpdateRequestDTO":{"allOf":[{"$ref":"#/components/schemas/AbstractAnnouncementCreateUpdateRequestDTO"},{"type":"object","properties":{"title":{"$ref":"#/components/schemas/MultiLanguage"},"message":{"$ref":"#/components/schemas/MultiLanguage"},"resume":{"$ref":"#/components/schemas/MultiLanguage"}}}]},"AbstractAnnouncementCreateUpdateRequestDTO":{"type":"object","discriminator":{"propertyName":"sectionId"},"properties":{"sectionId":{"type":"string"}}},"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"]},"AnnouncementExternalDTO":{"type":"object","properties":{"id":{"type":"string"},"sectionId":{"type":"string"},"effectiveDate":{"type":"string","format":"date-time"},"expirationDate":{"type":"string","format":"date-time"},"notify":{"type":"boolean"},"hierarchyIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"groupIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"characteristics":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBoolean"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueDate"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueList"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueTree"}]},"uniqueItems":true},"repliesToComments":{"type":"array","items":{"type":"string"},"uniqueItems":true},"categoryIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"title":{"$ref":"#/components/schemas/MultiLanguage"},"message":{"$ref":"#/components/schemas/MultiLanguage"},"resume":{"$ref":"#/components/schemas/MultiLanguage"},"pinned":{"type":"boolean"},"hfBranded":{"type":"boolean"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CompanyFile"},"uniqueItems":true},"media":{"type":"array","items":{"$ref":"#/components/schemas/CompanyFile"},"uniqueItems":true},"author":{"type":"string"},"updatedBy":{"type":"string"},"updatedOn":{"type":"string","format":"date-time"},"signed":{"type":"boolean"},"reactionsEnabled":{"type":"boolean"},"commentsEnabled":{"type":"boolean"},"archiveOnExpiration":{"type":"boolean"},"coverImageURL":{"type":"string"},"iconImageURL":{"type":"string"},"draft":{"type":"boolean"},"visibleOnLogin":{"type":"boolean"},"notified":{"type":"boolean"},"effective":{"type":"boolean"},"expired":{"type":"boolean"},"editable":{"type":"boolean"},"cloneable":{"type":"boolean"},"contentReady":{"type":"boolean"},"reachedAudience":{"type":"integer","format":"int32"},"expectedAudience":{"type":"integer","format":"int64"},"archived":{"type":"boolean"},"numComments":{"type":"integer","format":"int32"},"likedCount":{"type":"integer","format":"int32"}}},"EmployeeCharacteristicValueBoolean":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"boolean"}}}]},"EmployeeCharacteristicValueBase":{"type":"object","description":"Base class for employee characteristic values","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/EmployeeCharacteristicValueList","DATE":"#/components/schemas/EmployeeCharacteristicValueDate","BOOLEAN":"#/components/schemas/EmployeeCharacteristicValueBoolean","TREE":"#/components/schemas/EmployeeCharacteristicValueTree"}},"properties":{"characteristicId":{"type":"string"},"id":{"type":"string"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}}},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN","TREE"]},"EmployeeCharacteristicValueDate":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"value":{"type":"string"}}}]},"EmployeeCharacteristicValueList":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"string"}}}]},"EmployeeCharacteristicValueTree":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"string"},"assignedPath":{"type":"array","items":{"type":"string"}},"assignedOn":{"type":"string","format":"date-time"}}}]},"CompanyFile":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"fileType":{"type":"string"},"filePath":{"type":"string"},"fileSize":{"type":"number","format":"double"}}}}},"paths":{"/api/v1/company/announcements/{announcementId}":{"put":{"tags":["announcements-resource"],"operationId":"updateCompanyAnnouncement","parameters":[{"name":"announcementId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"*/*":{"schema":{"oneOf":[{"$ref":"#/components/schemas/LifeEventAnnouncementCreateUpdateRequestDTO"}]}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AnnouncementExternalDTO"}}}}}}}}}
```

## DELETE /api/v1/company/announcements/{announcementId}

>

```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":{"AnnouncementExternalDTO":{"type":"object","properties":{"id":{"type":"string"},"sectionId":{"type":"string"},"effectiveDate":{"type":"string","format":"date-time"},"expirationDate":{"type":"string","format":"date-time"},"notify":{"type":"boolean"},"hierarchyIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"groupIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"characteristics":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBoolean"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueDate"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueList"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueTree"}]},"uniqueItems":true},"repliesToComments":{"type":"array","items":{"type":"string"},"uniqueItems":true},"categoryIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"title":{"$ref":"#/components/schemas/MultiLanguage"},"message":{"$ref":"#/components/schemas/MultiLanguage"},"resume":{"$ref":"#/components/schemas/MultiLanguage"},"pinned":{"type":"boolean"},"hfBranded":{"type":"boolean"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CompanyFile"},"uniqueItems":true},"media":{"type":"array","items":{"$ref":"#/components/schemas/CompanyFile"},"uniqueItems":true},"author":{"type":"string"},"updatedBy":{"type":"string"},"updatedOn":{"type":"string","format":"date-time"},"signed":{"type":"boolean"},"reactionsEnabled":{"type":"boolean"},"commentsEnabled":{"type":"boolean"},"archiveOnExpiration":{"type":"boolean"},"coverImageURL":{"type":"string"},"iconImageURL":{"type":"string"},"draft":{"type":"boolean"},"visibleOnLogin":{"type":"boolean"},"notified":{"type":"boolean"},"effective":{"type":"boolean"},"expired":{"type":"boolean"},"editable":{"type":"boolean"},"cloneable":{"type":"boolean"},"contentReady":{"type":"boolean"},"reachedAudience":{"type":"integer","format":"int32"},"expectedAudience":{"type":"integer","format":"int64"},"archived":{"type":"boolean"},"numComments":{"type":"integer","format":"int32"},"likedCount":{"type":"integer","format":"int32"}}},"EmployeeCharacteristicValueBoolean":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"boolean"}}}]},"EmployeeCharacteristicValueBase":{"type":"object","description":"Base class for employee characteristic values","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/EmployeeCharacteristicValueList","DATE":"#/components/schemas/EmployeeCharacteristicValueDate","BOOLEAN":"#/components/schemas/EmployeeCharacteristicValueBoolean","TREE":"#/components/schemas/EmployeeCharacteristicValueTree"}},"properties":{"characteristicId":{"type":"string"},"id":{"type":"string"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}}},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN","TREE"]},"EmployeeCharacteristicValueDate":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"value":{"type":"string"}}}]},"EmployeeCharacteristicValueList":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"string"}}}]},"EmployeeCharacteristicValueTree":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"string"},"assignedPath":{"type":"array","items":{"type":"string"}},"assignedOn":{"type":"string","format":"date-time"}}}]},"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"]},"CompanyFile":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"fileType":{"type":"string"},"filePath":{"type":"string"},"fileSize":{"type":"number","format":"double"}}}}},"paths":{"/api/v1/company/announcements/{announcementId}":{"delete":{"tags":["announcements-resource"],"operationId":"deleteCompanyAnnouncement","parameters":[{"name":"announcementId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AnnouncementExternalDTO"}}}}}}}}}
```

## POST /api/v1/company/announcements

>

```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":{"LifeEventAnnouncementCreateUpdateRequestDTO":{"allOf":[{"$ref":"#/components/schemas/AbstractAnnouncementCreateUpdateRequestDTO"},{"type":"object","properties":{"title":{"$ref":"#/components/schemas/MultiLanguage"},"message":{"$ref":"#/components/schemas/MultiLanguage"},"resume":{"$ref":"#/components/schemas/MultiLanguage"}}}]},"AbstractAnnouncementCreateUpdateRequestDTO":{"type":"object","discriminator":{"propertyName":"sectionId"},"properties":{"sectionId":{"type":"string"}}},"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"]},"AnnouncementExternalDTO":{"type":"object","properties":{"id":{"type":"string"},"sectionId":{"type":"string"},"effectiveDate":{"type":"string","format":"date-time"},"expirationDate":{"type":"string","format":"date-time"},"notify":{"type":"boolean"},"hierarchyIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"groupIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"characteristics":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBoolean"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueDate"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueList"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueTree"}]},"uniqueItems":true},"repliesToComments":{"type":"array","items":{"type":"string"},"uniqueItems":true},"categoryIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"title":{"$ref":"#/components/schemas/MultiLanguage"},"message":{"$ref":"#/components/schemas/MultiLanguage"},"resume":{"$ref":"#/components/schemas/MultiLanguage"},"pinned":{"type":"boolean"},"hfBranded":{"type":"boolean"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CompanyFile"},"uniqueItems":true},"media":{"type":"array","items":{"$ref":"#/components/schemas/CompanyFile"},"uniqueItems":true},"author":{"type":"string"},"updatedBy":{"type":"string"},"updatedOn":{"type":"string","format":"date-time"},"signed":{"type":"boolean"},"reactionsEnabled":{"type":"boolean"},"commentsEnabled":{"type":"boolean"},"archiveOnExpiration":{"type":"boolean"},"coverImageURL":{"type":"string"},"iconImageURL":{"type":"string"},"draft":{"type":"boolean"},"visibleOnLogin":{"type":"boolean"},"notified":{"type":"boolean"},"effective":{"type":"boolean"},"expired":{"type":"boolean"},"editable":{"type":"boolean"},"cloneable":{"type":"boolean"},"contentReady":{"type":"boolean"},"reachedAudience":{"type":"integer","format":"int32"},"expectedAudience":{"type":"integer","format":"int64"},"archived":{"type":"boolean"},"numComments":{"type":"integer","format":"int32"},"likedCount":{"type":"integer","format":"int32"}}},"EmployeeCharacteristicValueBoolean":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"boolean"}}}]},"EmployeeCharacteristicValueBase":{"type":"object","description":"Base class for employee characteristic values","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/EmployeeCharacteristicValueList","DATE":"#/components/schemas/EmployeeCharacteristicValueDate","BOOLEAN":"#/components/schemas/EmployeeCharacteristicValueBoolean","TREE":"#/components/schemas/EmployeeCharacteristicValueTree"}},"properties":{"characteristicId":{"type":"string"},"id":{"type":"string"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}}},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN","TREE"]},"EmployeeCharacteristicValueDate":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"value":{"type":"string"}}}]},"EmployeeCharacteristicValueList":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"string"}}}]},"EmployeeCharacteristicValueTree":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"string"},"assignedPath":{"type":"array","items":{"type":"string"}},"assignedOn":{"type":"string","format":"date-time"}}}]},"CompanyFile":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"fileType":{"type":"string"},"filePath":{"type":"string"},"fileSize":{"type":"number","format":"double"}}}}},"paths":{"/api/v1/company/announcements":{"post":{"tags":["announcements-resource"],"operationId":"createCompanyAnnouncement","requestBody":{"content":{"*/*":{"schema":{"oneOf":[{"$ref":"#/components/schemas/LifeEventAnnouncementCreateUpdateRequestDTO"}]}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AnnouncementExternalDTO"}}}}}}}}}
```

## POST /api/v1/company/announcements/translate

>

```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":{"AnnouncementTranslateRequestDTO":{"type":"object","properties":{"sectionId":{"type":"string"},"languageCode":{"type":"string"},"title":{"type":"string"},"content":{"type":"string"},"resume":{"type":"string"}}},"AnnouncementTranslationDTO":{"type":"object","properties":{"title":{"$ref":"#/components/schemas/MultiLanguage"},"content":{"$ref":"#/components/schemas/MultiLanguage"},"resume":{"$ref":"#/components/schemas/MultiLanguage"}}},"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"]}}},"paths":{"/api/v1/company/announcements/translate":{"post":{"tags":["announcements-resource"],"operationId":"translateAnnouncement","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/AnnouncementTranslateRequestDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AnnouncementTranslationDTO"}}}}}}}}}
```

## GET /api/v1/company/announcements/{sectionId}/resume

>

```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":{"AnnouncementOrder":{"type":"string","description":"Type announcement order","enum":["RECENT","OLDER","MOST_COMMENTED","MOST_LIKED","MOST_VIEWED"]},"PaginableGenericListResultAnnouncementExternalDTO":{"type":"object","properties":{"from":{"type":"integer","format":"int32"},"to":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"noContent":{"type":"boolean"},"results":{"type":"array","items":{"$ref":"#/components/schemas/AnnouncementExternalDTO"}}}},"AnnouncementExternalDTO":{"type":"object","properties":{"id":{"type":"string"},"sectionId":{"type":"string"},"effectiveDate":{"type":"string","format":"date-time"},"expirationDate":{"type":"string","format":"date-time"},"notify":{"type":"boolean"},"hierarchyIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"groupIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"characteristics":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBoolean"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueDate"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueList"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueTree"}]},"uniqueItems":true},"repliesToComments":{"type":"array","items":{"type":"string"},"uniqueItems":true},"categoryIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"title":{"$ref":"#/components/schemas/MultiLanguage"},"message":{"$ref":"#/components/schemas/MultiLanguage"},"resume":{"$ref":"#/components/schemas/MultiLanguage"},"pinned":{"type":"boolean"},"hfBranded":{"type":"boolean"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CompanyFile"},"uniqueItems":true},"media":{"type":"array","items":{"$ref":"#/components/schemas/CompanyFile"},"uniqueItems":true},"author":{"type":"string"},"updatedBy":{"type":"string"},"updatedOn":{"type":"string","format":"date-time"},"signed":{"type":"boolean"},"reactionsEnabled":{"type":"boolean"},"commentsEnabled":{"type":"boolean"},"archiveOnExpiration":{"type":"boolean"},"coverImageURL":{"type":"string"},"iconImageURL":{"type":"string"},"draft":{"type":"boolean"},"visibleOnLogin":{"type":"boolean"},"notified":{"type":"boolean"},"effective":{"type":"boolean"},"expired":{"type":"boolean"},"editable":{"type":"boolean"},"cloneable":{"type":"boolean"},"contentReady":{"type":"boolean"},"reachedAudience":{"type":"integer","format":"int32"},"expectedAudience":{"type":"integer","format":"int64"},"archived":{"type":"boolean"},"numComments":{"type":"integer","format":"int32"},"likedCount":{"type":"integer","format":"int32"}}},"EmployeeCharacteristicValueBoolean":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"boolean"}}}]},"EmployeeCharacteristicValueBase":{"type":"object","description":"Base class for employee characteristic values","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/EmployeeCharacteristicValueList","DATE":"#/components/schemas/EmployeeCharacteristicValueDate","BOOLEAN":"#/components/schemas/EmployeeCharacteristicValueBoolean","TREE":"#/components/schemas/EmployeeCharacteristicValueTree"}},"properties":{"characteristicId":{"type":"string"},"id":{"type":"string"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}}},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN","TREE"]},"EmployeeCharacteristicValueDate":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"value":{"type":"string"}}}]},"EmployeeCharacteristicValueList":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"string"}}}]},"EmployeeCharacteristicValueTree":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"string"},"assignedPath":{"type":"array","items":{"type":"string"}},"assignedOn":{"type":"string","format":"date-time"}}}]},"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"]},"CompanyFile":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"fileType":{"type":"string"},"filePath":{"type":"string"},"fileSize":{"type":"number","format":"double"}}}}},"paths":{"/api/v1/company/announcements/{sectionId}/resume":{"get":{"tags":["announcements-resource"],"operationId":"geAnnouncementResumes","parameters":[{"name":"sectionId","in":"path","required":true,"schema":{"type":"string"}},{"name":"announcementText","in":"query","required":false,"schema":{"type":"string"}},{"name":"fromAnnouncement","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"name":"toAnnouncement","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":10}},{"name":"from","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"to","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"hierarchyId","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"filters","in":"query","required":false,"schema":{"type":"string"}},{"name":"groupId","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"categoryId","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"pinned","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"signed","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"hfSigned","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"published","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"draft","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"archived","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"reply","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"hasReactions","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"hasComments","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"orderBy","in":"query","required":false,"schema":{"$ref":"#/components/schemas/AnnouncementOrder"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PaginableGenericListResultAnnouncementExternalDTO"}}}}}}}}}
```

## GET /api/v1/company/announcements/read/{announcementId}

>

```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":{"AnnouncementExternalDTO":{"type":"object","properties":{"id":{"type":"string"},"sectionId":{"type":"string"},"effectiveDate":{"type":"string","format":"date-time"},"expirationDate":{"type":"string","format":"date-time"},"notify":{"type":"boolean"},"hierarchyIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"groupIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"characteristics":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBoolean"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueDate"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueList"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueTree"}]},"uniqueItems":true},"repliesToComments":{"type":"array","items":{"type":"string"},"uniqueItems":true},"categoryIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"title":{"$ref":"#/components/schemas/MultiLanguage"},"message":{"$ref":"#/components/schemas/MultiLanguage"},"resume":{"$ref":"#/components/schemas/MultiLanguage"},"pinned":{"type":"boolean"},"hfBranded":{"type":"boolean"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CompanyFile"},"uniqueItems":true},"media":{"type":"array","items":{"$ref":"#/components/schemas/CompanyFile"},"uniqueItems":true},"author":{"type":"string"},"updatedBy":{"type":"string"},"updatedOn":{"type":"string","format":"date-time"},"signed":{"type":"boolean"},"reactionsEnabled":{"type":"boolean"},"commentsEnabled":{"type":"boolean"},"archiveOnExpiration":{"type":"boolean"},"coverImageURL":{"type":"string"},"iconImageURL":{"type":"string"},"draft":{"type":"boolean"},"visibleOnLogin":{"type":"boolean"},"notified":{"type":"boolean"},"effective":{"type":"boolean"},"expired":{"type":"boolean"},"editable":{"type":"boolean"},"cloneable":{"type":"boolean"},"contentReady":{"type":"boolean"},"reachedAudience":{"type":"integer","format":"int32"},"expectedAudience":{"type":"integer","format":"int64"},"archived":{"type":"boolean"},"numComments":{"type":"integer","format":"int32"},"likedCount":{"type":"integer","format":"int32"}}},"EmployeeCharacteristicValueBoolean":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"boolean"}}}]},"EmployeeCharacteristicValueBase":{"type":"object","description":"Base class for employee characteristic values","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/EmployeeCharacteristicValueList","DATE":"#/components/schemas/EmployeeCharacteristicValueDate","BOOLEAN":"#/components/schemas/EmployeeCharacteristicValueBoolean","TREE":"#/components/schemas/EmployeeCharacteristicValueTree"}},"properties":{"characteristicId":{"type":"string"},"id":{"type":"string"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}}},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN","TREE"]},"EmployeeCharacteristicValueDate":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"value":{"type":"string"}}}]},"EmployeeCharacteristicValueList":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"string"}}}]},"EmployeeCharacteristicValueTree":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"string"},"assignedPath":{"type":"array","items":{"type":"string"}},"assignedOn":{"type":"string","format":"date-time"}}}]},"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"]},"CompanyFile":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"fileType":{"type":"string"},"filePath":{"type":"string"},"fileSize":{"type":"number","format":"double"}}}}},"paths":{"/api/v1/company/announcements/read/{announcementId}":{"get":{"tags":["announcements-resource"],"operationId":"getEmployeeAnnouncementById","parameters":[{"name":"announcementId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AnnouncementExternalDTO"}}}}}}}}}
```
