Bookmark - Updates a bookmark's details

Updates details of an existing bookmark associated with a report.

put

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

Authorizations

Path parameters

bookmarkIdstring uuidrequired

Enter ID of an existing bookmark.

reportIdstring uuidrequired

Enter ID of an existing report.

Query parameters

versionstring

The requested API version

Header parameters

embedfast-user-idstring

Optional User Id

Body

application/jsontext/jsonapplication/*+json

bookmarkStatenullable string

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.

displayNamenullable string

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.

typeenum

Enum for bookmark type.

Options: personal, shared

Responses

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/reports/{reportId}/bookmarks/{bookmarkId}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"type":"personal"}'

200

401

403

404

409

500

200

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

Success: Bookmark details successfully updated.