Skip to content

Report a BrandHub listing

POST
/api/v1/hub/{org}/{brand}/reports
curl --request POST \
--url http://localhost:3000/api/v1/hub/example/example/reports \
--header 'Content-Type: application/json' \
--data '{ "reason": "impersonation", "note": "example", "contact": "example" }'

Tell a public listing’s owner, and this server’s operator, what is wrong with it. Nothing about it is public. Anyone may report; a few an hour from one address, and the address is never kept.

No key needed.

org
required
string

The listing’s organization

brand
required
string

The listing’s brand

Media typeapplication/json
object
reason
required

Impersonation: It pretends to be the brand’s owner; trademark: It uses a trademark without permission; inaccurate: Its rules or files are wrong or out of date; abuse: Spam, malware or offensive content; other: Something else

string
Allowed values: impersonation trademark inaccurate abuse other
note

What is wrong, in your words

string
<= 2000 characters
contact

How the listing’s owner may reach you, if you want them to: seen by them and this server’s operator only

string
<= 200 characters

Received

Media typeapplication/json
object
data
required
object
received
required
boolean
Example
{
"data": {
"received": true
}
}

An error

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
detail
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"detail": "example"
}
}