Bookmark

A Bookmark represents a saved reference to a platform record. It is always owned by a user and organized under a user-defined type. Bookmarks are immutable after creation – to change the type, record reference, or title, remove the existing bookmark and create a new one.

Sample Object

{
  "id": "bkm_abc123def456",
  "type": "favorite",
  "record_id": "frm_ghi789jkl012",
  "user_id": "usr_mno345pqr678",
  "title": "Customer Feedback Form"
}

Fields

Field	Type	Description
`id`	string	Unique identifier for the bookmark. Auto-generated on creation.
`type`	string	User-defined category for organizing bookmarks. Required. Used as a path parameter in list and delete operations.
`record_id`	string	Identifier of the platform record being bookmarked. Required.
`user_id`	string	Identifier of the user who owns the bookmark. Required. Set automatically from the path parameter on creation.
`title`	string	Human-readable label for the bookmark. Optional. Displayed in UI lists for quick identification.

Actions

Creating a bookmark

Create a new bookmark for a user under a specific type. The record_id points to any platform record. The title is optional but recommended for display purposes.

Bookmark creation is available through the SDK and REST API.

POST /api/v1/bookmarks/usr_abc123def456/type/favorite

{
  "record_id": "frm_ghi789jkl012",
  "title": "Customer Feedback Form"
}

Successful response

{
  "id": "bkm_mno345pqr678",
  "type": "favorite",
  "record_id": "frm_ghi789jkl012",
  "user_id": "usr_abc123def456",
  "title": "Customer Feedback Form"
}

Listing own bookmarks

Retrieve all bookmarks of a given type for the currently authenticated user. This endpoint derives the user ID from the authentication context so you do not need to pass it explicitly.

Bookmark retrieval is available through the SDK and REST API.

GET /api/v1/bookmarks/me/type/favorite

Successful response

[
  {
    "id": "bkm_mno345pqr678",
    "type": "favorite",
    "record_id": "frm_ghi789jkl012",
    "user_id": "usr_abc123def456",
    "title": "Customer Feedback Form"
  },
  {
    "id": "bkm_stu901vwx234",
    "type": "favorite",
    "record_id": "usr_def456ghi789",
    "user_id": "usr_abc123def456",
    "title": "John's Profile"
  }
]

Listing a specific users bookmarks

Retrieve all bookmarks of a given type for any user by their user ID. Requires the caller to have appropriate read permissions for the target user.

Bookmark retrieval is available through the SDK and REST API.

GET /api/v1/bookmarks/usr_mno345pqr678/type/favorite

Successful response

[
  {
    "id": "bkm_abc123def456",
    "type": "favorite",
    "record_id": "frm_ghi789jkl012",
    "user_id": "usr_mno345pqr678",
    "title": "Customer Feedback Form"
  }
]

Removing a bookmark

Remove a bookmark by its ID, scoped to the owning user and type. This operation is irreversible.

Bookmark removal is available through the SDK and REST API.