Act on a report or a claim

PATCH

/api/v1/hub/reports/{id}

curl --request PATCH \
  --url http://localhost:3000/api/v1/hub/reports/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "status": "open", "delist": true }'

Mark it resolved, or open again; delist takes its listing off BrandHub (the brand goes private).

Scope: admin.

Authorizations

• bearer
• session
• None

Parameters

Path Parameters

id

required

string

The report’s id

Request Body^required

Media typeapplication/json

object

status

string

Allowed values: open resolved

delist

Take the listing off BrandHub: the brand goes private

boolean

Responses

200

The report

Media typeapplication/json

object

data

required

object

id

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

status

required

string

Allowed values: open resolved

brand

required

object

slug

required

string

visibility

required

string

Allowed values: private public

Example

{
  "data": {
    "status": "open",
    "brand": {
      "visibility": "private"
    }
  }
}

default

An error

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

detail

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "detail": "example"
  }
}