Topics

Organize and categorize board content to help advocates discover relevant messages to share.

Topics allow advocates to filter and discover content that aligns with their interests and expertise. Content creators can assign topics to messages and stories on the board, while advocates use topics to browse and find relevant content to share on their social channels. Use these endpoints to create, manage, and organize topics for your advocacy program.

Topics work with both message-based and story-based boards, providing consistent content organization across your advocacy program.

List Topics

Parameters

Parameter	Type	Required	Description
q	String	No	Search for topics by name.
boardId	String	No	Limit the results by board.

Example Request

curl -i https://api.oktopost.com/v2/board-topic

Example Result

{
	"Result": true,
	"Items": [
		{
			"Id": "tpc000000000001",
			"Name": "Blog",
			"BoardId": "brd000000000001",
			"Used": "0",
			"Subscribers": "0",
			"LastUsedDate": "2020-11-01 07:57:07"
		},
		{
			"Id": "tpc000000000002",
			"Name": "Canada",
			"BoardId": "brd000000000001",
			"Used": "0",
			"Subscribers": "0",
			"LastUsedDate": "2020-11-03 02:56:52"
		},
		{
			"Id": "tpc000000000003",
			"Name": "Summer",
			"BoardId": "brd000000000002",
			"Used": "0",
			"Subscribers": "0",
			"LastUsedDate": "2020-11-07 07:10:44"
		},
		{
			"Id": "tpc000000000004",
			"Name": "Information",
			"BoardId": "brd000000000002",
			"Used": "2",
			"Subscribers": "2",
			"LastUsedDate": "2020-10-01 23:47:31"
		}
	],
	"Total": 4
}

Add Topic

Note that when you create a new topic, advocates on the board will see a notification to subscribe to it the next time they log in.

Example Request

curl -i https://api.oktopost.com/v2/board-topic -X POST \	
	-d boardId=brd000000000001 \
	-d name="Topic Name"

Example Result

{
	"Result": true,
	"Topic": 
	{
		"Id": "tpc000000000004",
		"Name": "Information",
		"BoardId": "brd000000000002",
		"Used": "7",
		"Subscribers": "7",
		"LastUsedDate": "2020-10-01 23:47:31"
	}
}

Update Topic

Example Request

curl -i https://api.oktopost.com/v2/board-topic/tpc000000000001 -X POST \	
	-d name="Topic Name"

Example Result

{
	"Result": true,
	"Topic": 
	{
		"Id": "tpc000000000004",
		"Name": "Disinformation",
		"BoardId": "brd000000000002",
		"Used": "7",
		"Subscribers": "7",
		"LastUsedDate": "2020-10-01 23:47:31"
	}
}

Delete Topic

Example Request

curl -i https://api.oktopost.com/v2/board-topic/tpc000000000001 -X DELETE

On this page