Move, reorder or rename a favourite
PATCH
/api/workspaces/{workspaceId}/favourites/{id}
const url = 'http://localhost:8080/api/workspaces/example/favourites/example';const options = { method: 'PATCH', headers: {cookie: 'auth_session=<auth_session>', 'Content-Type': 'application/json'}, body: '{"parentId":"example","position":1,"title":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PATCH \ --url http://localhost:8080/api/workspaces/example/favourites/example \ --header 'Content-Type: application/json' \ --cookie auth_session=<auth_session> \ --data '{ "parentId": "example", "position": 1, "title": "example" }'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”workspaceId
required
string
id
required
string
Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
parentId
string | null
position
integer
title
string
Example generated
{ "parentId": "example", "position": 1, "title": "example"}Responses
Section titled “Responses”Successful response
Media typeapplication/json
object
success
Whether the request succeeded.
boolean
data
Endpoint-specific response payload.
message
string
error
string
Example
{ "message": "Operation completed", "error": "Error message"}Invalid request
Media typeapplication/json
object
success
boolean
error
string
Example
{ "error": "Error message"}Internal server error
Media typeapplication/json
object
success
boolean
error
string
Example
{ "error": "Error message"}