Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Announcements Resource

put
Authorizations
SessionIdstringRequired

SessionId

Path parameters
announcementIdstringRequired
Body
Responses
200

OK

*/*
idstringOptional
sectionIdstringOptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6
effectiveDatestring · date-timeOptional
expirationDatestring · date-timeOptional
notifybooleanOptional
hierarchyIdsstring[]OptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6
groupIdsstring[]OptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6
repliesToCommentsstring[]OptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6
categoryIdsstring[]OptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6
pinnedbooleanOptional
hfBrandedbooleanOptional
authorstringOptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6
updatedBystringOptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6
updatedOnstring · date-timeOptional
signedbooleanOptional
reactionsEnabledbooleanOptional
commentsEnabledbooleanOptional
archiveOnExpirationbooleanOptional
coverImageURLstringOptional
iconImageURLstringOptional
draftbooleanOptional
visibleOnLoginbooleanOptional
notifiedbooleanOptional
effectivebooleanOptional
expiredbooleanOptional
editablebooleanOptional
cloneablebooleanOptional
contentReadybooleanOptional
reachedAudienceinteger · int32Optional
expectedAudienceinteger · int64Optional
archivedbooleanOptional
numCommentsinteger · int32Optional
likedCountinteger · int32Optional
put/api/v1/company/announcements/{announcementId}
PUT /api/v1/company/announcements/{announcementId} HTTP/1.1
Host: api.happyforce.com
SessionId: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 355

{
  "sectionId": "64f8a0e2d5b7c9a1e3f4a5b6",
  "title": {
    "defaultValue": "Happy birthday!",
    "langValues": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "valid": true
  },
  "message": {
    "defaultValue": "Happy birthday!",
    "langValues": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "valid": true
  },
  "resume": {
    "defaultValue": "Happy birthday!",
    "langValues": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "valid": true
  }
}
200

OK

{
  "id": "text",
  "sectionId": "64f8a0e2d5b7c9a1e3f4a5b6",
  "effectiveDate": "2026-01-01T00:00:00.000Z",
  "expirationDate": "2026-01-01T00:00:00.000Z",
  "notify": true,
  "hierarchyIds": [
    "64f8a0e2d5b7c9a1e3f4a5b6"
  ],
  "groupIds": [
    "64f8a0e2d5b7c9a1e3f4a5b6"
  ],
  "characteristics": [
    {
      "characteristicId": "64f8a0e2d5b7c9a1e3f4a5b6",
      "id": "64f8a0e2d5b7c9a1e3f4a5b6",
      "questionType": "DATE",
      "value": true
    }
  ],
  "repliesToComments": [
    "64f8a0e2d5b7c9a1e3f4a5b6"
  ],
  "categoryIds": [
    "64f8a0e2d5b7c9a1e3f4a5b6"
  ],
  "title": {
    "defaultValue": "Happy birthday!",
    "langValues": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "valid": true
  },
  "message": {
    "defaultValue": "Happy birthday!",
    "langValues": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "valid": true
  },
  "resume": {
    "defaultValue": "Happy birthday!",
    "langValues": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "valid": true
  },
  "pinned": true,
  "hfBranded": true,
  "attachments": [
    {
      "id": "text",
      "name": "text",
      "fileType": "text",
      "filePath": "text",
      "fileSize": 1
    }
  ],
  "media": [
    {
      "id": "text",
      "name": "text",
      "fileType": "text",
      "filePath": "text",
      "fileSize": 1
    }
  ],
  "author": "64f8a0e2d5b7c9a1e3f4a5b6",
  "updatedBy": "64f8a0e2d5b7c9a1e3f4a5b6",
  "updatedOn": "2026-01-01T00:00:00.000Z",
  "signed": true,
  "reactionsEnabled": true,
  "commentsEnabled": true,
  "archiveOnExpiration": true,
  "coverImageURL": "text",
  "iconImageURL": "text",
  "draft": true,
  "visibleOnLogin": true,
  "notified": true,
  "effective": true,
  "expired": true,
  "editable": true,
  "cloneable": true,
  "contentReady": true,
  "reachedAudience": 1,
  "expectedAudience": 1,
  "archived": true,
  "numComments": 1,
  "likedCount": 1
}
delete
Authorizations
SessionIdstringRequired

SessionId

Path parameters
announcementIdstringRequired
Responses
200

OK

*/*
idstringOptional
sectionIdstringOptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6
effectiveDatestring · date-timeOptional
expirationDatestring · date-timeOptional
notifybooleanOptional
hierarchyIdsstring[]OptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6
groupIdsstring[]OptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6
repliesToCommentsstring[]OptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6
categoryIdsstring[]OptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6
pinnedbooleanOptional
hfBrandedbooleanOptional
authorstringOptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6
updatedBystringOptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6
updatedOnstring · date-timeOptional
signedbooleanOptional
reactionsEnabledbooleanOptional
commentsEnabledbooleanOptional
archiveOnExpirationbooleanOptional
coverImageURLstringOptional
iconImageURLstringOptional
draftbooleanOptional
visibleOnLoginbooleanOptional
notifiedbooleanOptional
effectivebooleanOptional
expiredbooleanOptional
editablebooleanOptional
cloneablebooleanOptional
contentReadybooleanOptional
reachedAudienceinteger · int32Optional
expectedAudienceinteger · int64Optional
archivedbooleanOptional
numCommentsinteger · int32Optional
likedCountinteger · int32Optional
delete/api/v1/company/announcements/{announcementId}
DELETE /api/v1/company/announcements/{announcementId} HTTP/1.1
Host: api.happyforce.com
SessionId: YOUR_API_KEY
Accept: */*
200

OK

{
  "id": "text",
  "sectionId": "64f8a0e2d5b7c9a1e3f4a5b6",
  "effectiveDate": "2026-01-01T00:00:00.000Z",
  "expirationDate": "2026-01-01T00:00:00.000Z",
  "notify": true,
  "hierarchyIds": [
    "64f8a0e2d5b7c9a1e3f4a5b6"
  ],
  "groupIds": [
    "64f8a0e2d5b7c9a1e3f4a5b6"
  ],
  "characteristics": [
    {
      "characteristicId": "64f8a0e2d5b7c9a1e3f4a5b6",
      "id": "64f8a0e2d5b7c9a1e3f4a5b6",
      "questionType": "DATE",
      "value": true
    }
  ],
  "repliesToComments": [
    "64f8a0e2d5b7c9a1e3f4a5b6"
  ],
  "categoryIds": [
    "64f8a0e2d5b7c9a1e3f4a5b6"
  ],
  "title": {
    "defaultValue": "Happy birthday!",
    "langValues": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "valid": true
  },
  "message": {
    "defaultValue": "Happy birthday!",
    "langValues": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "valid": true
  },
  "resume": {
    "defaultValue": "Happy birthday!",
    "langValues": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "valid": true
  },
  "pinned": true,
  "hfBranded": true,
  "attachments": [
    {
      "id": "text",
      "name": "text",
      "fileType": "text",
      "filePath": "text",
      "fileSize": 1
    }
  ],
  "media": [
    {
      "id": "text",
      "name": "text",
      "fileType": "text",
      "filePath": "text",
      "fileSize": 1
    }
  ],
  "author": "64f8a0e2d5b7c9a1e3f4a5b6",
  "updatedBy": "64f8a0e2d5b7c9a1e3f4a5b6",
  "updatedOn": "2026-01-01T00:00:00.000Z",
  "signed": true,
  "reactionsEnabled": true,
  "commentsEnabled": true,
  "archiveOnExpiration": true,
  "coverImageURL": "text",
  "iconImageURL": "text",
  "draft": true,
  "visibleOnLogin": true,
  "notified": true,
  "effective": true,
  "expired": true,
  "editable": true,
  "cloneable": true,
  "contentReady": true,
  "reachedAudience": 1,
  "expectedAudience": 1,
  "archived": true,
  "numComments": 1,
  "likedCount": 1
}
post
Authorizations
SessionIdstringRequired

SessionId

Body
Responses
200

OK

*/*
idstringOptional
sectionIdstringOptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6
effectiveDatestring · date-timeOptional
expirationDatestring · date-timeOptional
notifybooleanOptional
hierarchyIdsstring[]OptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6
groupIdsstring[]OptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6
repliesToCommentsstring[]OptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6
categoryIdsstring[]OptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6
pinnedbooleanOptional
hfBrandedbooleanOptional
authorstringOptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6
updatedBystringOptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6
updatedOnstring · date-timeOptional
signedbooleanOptional
reactionsEnabledbooleanOptional
commentsEnabledbooleanOptional
archiveOnExpirationbooleanOptional
coverImageURLstringOptional
iconImageURLstringOptional
draftbooleanOptional
visibleOnLoginbooleanOptional
notifiedbooleanOptional
effectivebooleanOptional
expiredbooleanOptional
editablebooleanOptional
cloneablebooleanOptional
contentReadybooleanOptional
reachedAudienceinteger · int32Optional
expectedAudienceinteger · int64Optional
archivedbooleanOptional
numCommentsinteger · int32Optional
likedCountinteger · int32Optional
post/api/v1/company/announcements
POST /api/v1/company/announcements HTTP/1.1
Host: api.happyforce.com
SessionId: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 355

{
  "sectionId": "64f8a0e2d5b7c9a1e3f4a5b6",
  "title": {
    "defaultValue": "Happy birthday!",
    "langValues": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "valid": true
  },
  "message": {
    "defaultValue": "Happy birthday!",
    "langValues": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "valid": true
  },
  "resume": {
    "defaultValue": "Happy birthday!",
    "langValues": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "valid": true
  }
}
200

OK

{
  "id": "text",
  "sectionId": "64f8a0e2d5b7c9a1e3f4a5b6",
  "effectiveDate": "2026-01-01T00:00:00.000Z",
  "expirationDate": "2026-01-01T00:00:00.000Z",
  "notify": true,
  "hierarchyIds": [
    "64f8a0e2d5b7c9a1e3f4a5b6"
  ],
  "groupIds": [
    "64f8a0e2d5b7c9a1e3f4a5b6"
  ],
  "characteristics": [
    {
      "characteristicId": "64f8a0e2d5b7c9a1e3f4a5b6",
      "id": "64f8a0e2d5b7c9a1e3f4a5b6",
      "questionType": "DATE",
      "value": true
    }
  ],
  "repliesToComments": [
    "64f8a0e2d5b7c9a1e3f4a5b6"
  ],
  "categoryIds": [
    "64f8a0e2d5b7c9a1e3f4a5b6"
  ],
  "title": {
    "defaultValue": "Happy birthday!",
    "langValues": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "valid": true
  },
  "message": {
    "defaultValue": "Happy birthday!",
    "langValues": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "valid": true
  },
  "resume": {
    "defaultValue": "Happy birthday!",
    "langValues": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "valid": true
  },
  "pinned": true,
  "hfBranded": true,
  "attachments": [
    {
      "id": "text",
      "name": "text",
      "fileType": "text",
      "filePath": "text",
      "fileSize": 1
    }
  ],
  "media": [
    {
      "id": "text",
      "name": "text",
      "fileType": "text",
      "filePath": "text",
      "fileSize": 1
    }
  ],
  "author": "64f8a0e2d5b7c9a1e3f4a5b6",
  "updatedBy": "64f8a0e2d5b7c9a1e3f4a5b6",
  "updatedOn": "2026-01-01T00:00:00.000Z",
  "signed": true,
  "reactionsEnabled": true,
  "commentsEnabled": true,
  "archiveOnExpiration": true,
  "coverImageURL": "text",
  "iconImageURL": "text",
  "draft": true,
  "visibleOnLogin": true,
  "notified": true,
  "effective": true,
  "expired": true,
  "editable": true,
  "cloneable": true,
  "contentReady": true,
  "reachedAudience": 1,
  "expectedAudience": 1,
  "archived": true,
  "numComments": 1,
  "likedCount": 1
}
post
Authorizations
SessionIdstringRequired

SessionId

Body
sectionIdstringOptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6
languageCodestringOptional
titlestringOptional
contentstringOptional
resumestringOptional
Responses
200

OK

*/*
post/api/v1/company/announcements/translate
POST /api/v1/company/announcements/translate HTTP/1.1
Host: api.happyforce.com
SessionId: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 110

{
  "sectionId": "64f8a0e2d5b7c9a1e3f4a5b6",
  "languageCode": "text",
  "title": "text",
  "content": "text",
  "resume": "text"
}
200

OK

{
  "title": {
    "defaultValue": "Happy birthday!",
    "langValues": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "valid": true
  },
  "content": {
    "defaultValue": "Happy birthday!",
    "langValues": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "valid": true
  },
  "resume": {
    "defaultValue": "Happy birthday!",
    "langValues": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "valid": true
  }
}
get
Authorizations
SessionIdstringRequired

SessionId

Path parameters
sectionIdstringRequiredExample: 64f8a0e2d5b7c9a1e3f4a5b6
Query parameters
announcementTextstringOptional
fromAnnouncementinteger · int32OptionalDefault: 0
toAnnouncementinteger · int32OptionalDefault: 10
fromstring · date-timeOptional
tostring · date-timeOptional
hierarchyIdstring[]OptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6
filtersstringOptional
groupIdstring[]OptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6
categoryIdstring[]OptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6
pinnedbooleanOptional
signedbooleanOptional
hfSignedbooleanOptional
publishedbooleanOptional
draftbooleanOptional
archivedbooleanOptional
replybooleanOptional
hasReactionsbooleanOptional
hasCommentsbooleanOptional
orderBystring · enumOptional

Type announcement order

Possible values:
Responses
200

OK

*/*
frominteger · int32Optional
tointeger · int32Optional
totalinteger · int32Optional
noContentbooleanOptional
get/api/v1/company/announcements/{sectionId}/resume
GET /api/v1/company/announcements/{sectionId}/resume HTTP/1.1
Host: api.happyforce.com
SessionId: YOUR_API_KEY
Accept: */*
200

OK

{
  "from": 1,
  "to": 1,
  "total": 1,
  "noContent": true,
  "results": [
    {
      "id": "text",
      "sectionId": "64f8a0e2d5b7c9a1e3f4a5b6",
      "effectiveDate": "2026-01-01T00:00:00.000Z",
      "expirationDate": "2026-01-01T00:00:00.000Z",
      "notify": true,
      "hierarchyIds": [
        "64f8a0e2d5b7c9a1e3f4a5b6"
      ],
      "groupIds": [
        "64f8a0e2d5b7c9a1e3f4a5b6"
      ],
      "characteristics": [
        {
          "characteristicId": "64f8a0e2d5b7c9a1e3f4a5b6",
          "id": "64f8a0e2d5b7c9a1e3f4a5b6",
          "questionType": "DATE",
          "value": true
        }
      ],
      "repliesToComments": [
        "64f8a0e2d5b7c9a1e3f4a5b6"
      ],
      "categoryIds": [
        "64f8a0e2d5b7c9a1e3f4a5b6"
      ],
      "title": {
        "defaultValue": "Happy birthday!",
        "langValues": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "valid": true
      },
      "message": {
        "defaultValue": "Happy birthday!",
        "langValues": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "valid": true
      },
      "resume": {
        "defaultValue": "Happy birthday!",
        "langValues": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "valid": true
      },
      "pinned": true,
      "hfBranded": true,
      "attachments": [
        {
          "id": "text",
          "name": "text",
          "fileType": "text",
          "filePath": "text",
          "fileSize": 1
        }
      ],
      "media": [
        {
          "id": "text",
          "name": "text",
          "fileType": "text",
          "filePath": "text",
          "fileSize": 1
        }
      ],
      "author": "64f8a0e2d5b7c9a1e3f4a5b6",
      "updatedBy": "64f8a0e2d5b7c9a1e3f4a5b6",
      "updatedOn": "2026-01-01T00:00:00.000Z",
      "signed": true,
      "reactionsEnabled": true,
      "commentsEnabled": true,
      "archiveOnExpiration": true,
      "coverImageURL": "text",
      "iconImageURL": "text",
      "draft": true,
      "visibleOnLogin": true,
      "notified": true,
      "effective": true,
      "expired": true,
      "editable": true,
      "cloneable": true,
      "contentReady": true,
      "reachedAudience": 1,
      "expectedAudience": 1,
      "archived": true,
      "numComments": 1,
      "likedCount": 1
    }
  ]
}
get
Authorizations
SessionIdstringRequired

SessionId

Path parameters
announcementIdstringRequired
Responses
200

OK

*/*
idstringOptional
sectionIdstringOptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6
effectiveDatestring · date-timeOptional
expirationDatestring · date-timeOptional
notifybooleanOptional
hierarchyIdsstring[]OptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6
groupIdsstring[]OptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6
repliesToCommentsstring[]OptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6
categoryIdsstring[]OptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6
pinnedbooleanOptional
hfBrandedbooleanOptional
authorstringOptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6
updatedBystringOptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6
updatedOnstring · date-timeOptional
signedbooleanOptional
reactionsEnabledbooleanOptional
commentsEnabledbooleanOptional
archiveOnExpirationbooleanOptional
coverImageURLstringOptional
iconImageURLstringOptional
draftbooleanOptional
visibleOnLoginbooleanOptional
notifiedbooleanOptional
effectivebooleanOptional
expiredbooleanOptional
editablebooleanOptional
cloneablebooleanOptional
contentReadybooleanOptional
reachedAudienceinteger · int32Optional
expectedAudienceinteger · int64Optional
archivedbooleanOptional
numCommentsinteger · int32Optional
likedCountinteger · int32Optional
get/api/v1/company/announcements/read/{announcementId}
GET /api/v1/company/announcements/read/{announcementId} HTTP/1.1
Host: api.happyforce.com
SessionId: YOUR_API_KEY
Accept: */*
200

OK

{
  "id": "text",
  "sectionId": "64f8a0e2d5b7c9a1e3f4a5b6",
  "effectiveDate": "2026-01-01T00:00:00.000Z",
  "expirationDate": "2026-01-01T00:00:00.000Z",
  "notify": true,
  "hierarchyIds": [
    "64f8a0e2d5b7c9a1e3f4a5b6"
  ],
  "groupIds": [
    "64f8a0e2d5b7c9a1e3f4a5b6"
  ],
  "characteristics": [
    {
      "characteristicId": "64f8a0e2d5b7c9a1e3f4a5b6",
      "id": "64f8a0e2d5b7c9a1e3f4a5b6",
      "questionType": "DATE",
      "value": true
    }
  ],
  "repliesToComments": [
    "64f8a0e2d5b7c9a1e3f4a5b6"
  ],
  "categoryIds": [
    "64f8a0e2d5b7c9a1e3f4a5b6"
  ],
  "title": {
    "defaultValue": "Happy birthday!",
    "langValues": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "valid": true
  },
  "message": {
    "defaultValue": "Happy birthday!",
    "langValues": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "valid": true
  },
  "resume": {
    "defaultValue": "Happy birthday!",
    "langValues": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "valid": true
  },
  "pinned": true,
  "hfBranded": true,
  "attachments": [
    {
      "id": "text",
      "name": "text",
      "fileType": "text",
      "filePath": "text",
      "fileSize": 1
    }
  ],
  "media": [
    {
      "id": "text",
      "name": "text",
      "fileType": "text",
      "filePath": "text",
      "fileSize": 1
    }
  ],
  "author": "64f8a0e2d5b7c9a1e3f4a5b6",
  "updatedBy": "64f8a0e2d5b7c9a1e3f4a5b6",
  "updatedOn": "2026-01-01T00:00:00.000Z",
  "signed": true,
  "reactionsEnabled": true,
  "commentsEnabled": true,
  "archiveOnExpiration": true,
  "coverImageURL": "text",
  "iconImageURL": "text",
  "draft": true,
  "visibleOnLogin": true,
  "notified": true,
  "effective": true,
  "expired": true,
  "editable": true,
  "cloneable": true,
  "contentReady": true,
  "reachedAudience": 1,
  "expectedAudience": 1,
  "archived": true,
  "numComments": 1,
  "likedCount": 1
}

Last updated