Advocacy
Boards
Retrieve employee advocacy boards and their configurations, including advocate information and shared content.
The Employee Advocacy Board is a platform where advocates share curated content on their personal social media channels. Each board contains advocates who have joined the program and the content shared with them. Use these endpoints to retrieve boards, view their configurations, and access advocate and content information.
Boards can be either message-based (legacy) or story-based (recommended). Story-based boards provide enhanced functionality and richer media options.
Get Board
Example Request
curl -i https://api.oktopost.com/v2/board/brd000000000001Example Result
{
"Result": true,
"Board": {
"Config": {
"Color": "#27373f",
"DefaultExpiration": "in_6_months",
"IconId": "",
"IsAllowSuggestionsEnabled": false,
"IsLeaderboardEnabled": true,
"LogoId": "",
"LogoPosition": "center",
"NotificationsDay": null,
"NotificationsEnabled": true,
"NotificationsTimeUTC": "10",
"PostAddress": "",
"SignUpDomains": false,
"SignUpEnabled": false,
"Slug": "",
"Terms": ""
},
"Created": "2016-10-30 11:23:34",
"Id": "brd000000000001",
"Name": "My Board",
"Status": "active",
"UsersCount": 0
}
}List Boards
Example Request
curl -i https://api.oktopost.com/v2/boardExample Result
{
"Result":true,
"Items":[
{
"Config": {
"Color": "#27373f",
"DefaultExpiration": "in_6_months",
"IconId": "",
"IsAllowSuggestionsEnabled": false,
"IsLeaderboardEnabled": true,
"LogoId": "",
"LogoPosition": "center",
"NotificationsDay": null,
"NotificationsEnabled": true,
"NotificationsTimeUTC": "10",
"PostAddress": "",
"SignUpDomains": false,
"SignUpEnabled": false,
"Slug": "",
"Terms": ""
},
"Created": "2016-10-30 11:23:34",
"Id": "brd000000000001",
"Name": "My Board",
"Status": "active",
"UsersCount": 0
},
...
],
"Total":2
}