Star a BrandHub listing
PUT
/api/v1/hub/{org}/{brand}/star
const url = 'http://localhost:3000/api/v1/hub/example/example/star';const options = {method: 'PUT', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PUT \ --url http://localhost:3000/api/v1/hub/example/example/star \ --header 'Authorization: Bearer <token>'A person, signed in: the public listing shows in their Starred tab on BrandHub, and counts on its Star button. Starring one already starred changes nothing.
Any caller; the scope needed is checked on what it acts on.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”org
required
string
The listing’s organization
brand
required
string
The listing’s brand
Responses
Section titled “Responses”Starred
Media typeapplication/json
object
data
required
object
starred
required
boolean
Example
{ "data": { "starred": true }}default
Section titled “default”An error
Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
detail
Examplegenerated
{ "error": { "code": "example", "message": "example", "detail": "example" }}