Bookmark - Update existing bookmark-related details

Updates details of an existing bookmark associated with a report.

put

Authorizations

Bearer

HTTPRequired

Please enter a valid token

Path parameters

bookmarkIdstring · uuidRequired

Enter ID of an existing bookmark.

reportIdstring · uuidRequired

Enter ID of an existing report.

Query parameters

versionstringOptional

The requested API version

Default: 1.0

Header parameters

embedfast-user-idstringOptional

Optional User Id

Body

application/jsontext/jsonapplication/*+json

Class for updating the properties of bookmark.

bookmarkStatestring | nullableOptional

A public property of type nullable string that has both a getter and a setter method, which allows for getting and setting the value of the BookmarkState property.

displayNamestring | nullableOptional

A public property of type nullable string that has both a getter and a setter method, which allows for getting and setting the value of the DisplayName property.

typestring · enumOptional

Enum for bookmark type.

Possible values:

Responses

200

Success: Bookmark details successfully updated.

text/plainapplication/jsontext/json

401

Unauthorized: Invalid credentials or missing/invalid authentication token.

text/plainapplication/jsontext/json

403

Forbidden: Access denied for updating this bookmark due to insufficient permissions or account restrictions.

text/plainapplication/jsontext/json

404

Not Found: The specified bookmark or report does not exist, the URL is invalid, or the resource has been deleted.

text/plainapplication/jsontext/json

409

Conflict: The update request could not be completed due to a conflict with the current state of the bookmark, such as attempting to modify a bookmark that has been changed or deleted by another process.

text/plainapplication/jsontext/json

500

Internal Server Error: An unexpected error occurred or a server timeout.

text/plainapplication/jsontext/json

put

/reports/{reportId}/bookmarks/{bookmarkId}

HTTPcURLJavaScriptPython

PUT /reports/{reportId}/bookmarks/{bookmarkId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 63

{
  "bookmarkState": "text",
  "displayName": "text",
  "type": "personal"
}

application/jsontext/jsonapplication/*+json

{
  "reportId": "123e4567-e89b-12d3-a456-426614174000",
  "modifiedByUserId": "text",
  "bookmarkState": "text",
  "displayName": "text",
  "reportBookmarkId": "123e4567-e89b-12d3-a456-426614174000",
  "type": "personal"
}