Skip to main content
POST
/
organizations
/
{organizationName}
/
bookmarks
Create a new bookmark
curl --request POST \
  --url https://{organization}.admin.credibledata.com/api/v0/organizations/{organizationName}/bookmarks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "bookmarkType": "WORKSPACE",
  "objectId": "<string>",
  "workspaceName": "<string>"
}
'
{
  "bookmarkType": "WORKSPACE",
  "objectId": "<string>",
  "organizationName": "<string>",
  "userName": "<string>",
  "workspaceName": "<string>",
  "createdAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
organizationName
string
required

The unique identifier of the organization Standard identifier pattern for resource names

Pattern: ^[a-zA-Z0-9_-]+$

Body

application/json

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

​
bookmarkType
enum<string>
required

The type of object being bookmarked

Available options:
WORKSPACE,
MODEL,
CHAT
​
objectId
string
required

The unique identifier of the bookmarked object

​
workspaceName
string | null

The workspace the bookmark is associated with (optional)

Response

Bookmark created successfully

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

​
bookmarkType
enum<string>
required

The type of object being bookmarked

Available options:
WORKSPACE,
MODEL,
CHAT
​
objectId
string
required

The unique identifier of the bookmarked object

​
organizationName
string

The organization name this bookmark belongs to

​
userName
string

The username of the user who owns the bookmark

​
workspaceName
string | null

The workspace the bookmark is associated with (optional)

​
createdAt
string<date-time>

ISO 8601 timestamp indicating when the bookmark was created