Advocacy
Messages
Manage message assets that advocates can share from the employee advocacy board.
This endpoint applies only to message-based boards. For new boards, use the Stories endpoint, which provides enhanced functionality and richer media options.
Board messages are text-based content assets that advocates can share from the employee advocacy board. Use these endpoints to add messages to boards, update existing messages, and manage message availability for your advocacy program.
Add Board Message
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| boardId | String | Yes | The board ID where the message will be published. |
| messageId | String | Yes | The message ID to add to the board. |
| startDate | String | No | The message publish date on the board. Format: YYYY-MM-DD HH:mm:ss (UTC). Default: current time |
| expireDate | String | No | The message expiration date. Format: YYYY-MM-DD HH:mm:ss (UTC). Default: based on board settings |
| important | Integer | No | Mark as important. Set to 1 to send push notifications to advocates when published. Default: 0 |
| topicIds | String | No | Comma-separated list of topic IDs to categorize this message. |
Example Request
curl -i https://api.oktopost.com/v2/board-message -X POST \
-d boardId=brd000000000001 \
-d messageId=002000000000001 \
-d startDate="2020-11-01 12:00:00" \
-d expireDate="2021-03-01 12:00:00" \
-d important=1 \
-d topicIds=tpc000000000001,tpc000000000002Example Result
{
"Result": true
}Remove Board Message
Example Request
curl -i https://api.oktopost.com/v2/board-message?boardId=brd000000000001&messageId=002000000000001 -X DELETE