Create a new bookmark

Creates a new bookmark for the current user within the organization. Bookmarks allow users to save references to workspaces, models, and chat conversations.

POST/organizations/{organizationName}/bookmarks

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

organizationName*string

The unique identifier of the organization

Match^[a-zA-Z0-9_ -]+$

Request Body

application/json

Represents a user bookmark for saving references to chats, reports, models, and governed reports

bookmarkType*BookmarkType

The type of object being bookmarked

Value in

"CHAT"
"REPORT"
"MODEL"
"GOVERNED_REPORT"

objectId*string

The fully-qualified identifier of the bookmarked object. Required shape per type:

CHAT — {workspaceName}/{chatDocumentPath} (1+ slash)
REPORT — {workspaceName}/{reportDocumentPath} (1+ slash)
MODEL — {projectName}/{packageName}/{modelPath} (2+ slashes)
GOVERNED_REPORT — {projectName}/{packageName}/{reportPath} (2+ slashes)

Response Body

`application/json`

curl --request POST \  --url 'https://example.com/organizations/string/bookmarks' \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{  "bookmarkType": "CHAT",  "objectId": "string"}'

{  "organizationName": "string",  "userName": "string",  "bookmarkType": "CHAT",  "objectId": "string",  "createdAt": "2019-08-24T14:15:22Z"}

Create a new bookmark

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`