Pins API

The Pins API allows you to create, manage, and organize pinned search results that appear prominently for specific queries. Improve search experience by ensuring high-quality, relevant content appears at the top of search results for important topics.

Use Cases

Search Result Curation

Pin high-quality documents and resources to appear at the top of search results for specific queries, ensuring users find the best content first.

Content Promotion

Highlight important announcements, policies, and frequently accessed documents by pinning them to relevant search terms.

Search Quality Control

Manage and update pinned results to maintain search quality and ensure users consistently find the most relevant and current information.

API Endpoints

Method	Endpoint	Purpose
POST	/rest/api/v1/editpin	Update pin Update an existing user-generated pin.
POST	/rest/api/v1/getpin	Read pin Read pin details given its ID.
POST	/rest/api/v1/listpins	List pins Lists all pins.
POST	/rest/api/v1/pin	Create pin Pin a document as a result for a given search query.Pin results that are known to be a good match.
POST	/rest/api/v1/unpin	Delete pin Unpin a previously pinned result.