Claim a BrandHub listing

POST

/api/v1/hub/{org}/{brand}/claims

curl --request POST \
  --url http://localhost:3000/api/v1/hub/example/example/claims \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "note": "example" }'

Say a public listing is your organization’s brand. It takes an organization admin, signed in, whose organization proved a domain or a GitHub account: the claim names it, with your email, for the listing’s owner and this server’s operator, who hand it over or take it down.

Scope: admin.

Authorizations

• bearer
• session
• None

Parameters

Path Parameters

org

required

string

The listing’s organization

brand

required

string

The listing’s brand

Request Body^required

Media typeapplication/json

object

note

Who you are to the brand, and whether you want the listing handed over or taken down

string

<= 2000 characters

Example^generated

{
  "note": "example"
}

Responses

202

Received

Media typeapplication/json

object

data

required

object

received

required

boolean

proof

required

What the claim names you as holding

string

Example

{
  "data": {
    "received": true
  }
}

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"
  }
}