FurniOpsDocs
API referenceBrand

Read an invitation to claim a brand

Reads the invitation behind a code FurniOps mailed: the profile, the address invited, when it expires, and whether the signed-in member can accept it (their verified address must be the one invited). A code that is unknown, used, revoked or expired answers 404. The code travels in the body so it never lands in a URL log.

  • Scopesbrand:write
  • Rate classwrite
POST/v1/brand/invitations/preview

Reads the invitation behind a code FurniOps mailed: the profile, the address invited, when it expires, and whether the signed-in member can accept it (their verified address must be the one invited). A code that is unknown, used, revoked or expired answers 404. The code travels in the body so it never lands in a URL log.

Authorization

apiKey
AuthorizationBearer <token>

An API key (fo_live_… / fo_test_…) as a bearer token

In: header

Header Parameters

FurniOps-Version?string

Dated API version; pinned per organisation on first use and overridable per request

Value in

  • "2026-10-01"
  • "2026-10-04"
FurniOps-Mode?string

The data the request acts on: test is the organisation's sandbox. An OAuth token picks it (live by default); an API key's mode is fixed, and naming the other one is refused

Value in

  • "live"
  • "test"
FurniOps-Dry-Run?string

Preview the write and change nothing: true answers the would-be response, explain a Preview (application/vnd.furniops.preview+json)

Value in

  • "true"
  • "explain"

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

An invitation to read

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/v1/brand/invitations/preview" \  -H "Content-Type: application/json" \  -d '{    "token": "string"  }'
{  "object": "claim_invitation",  "id": "string",  "profile": {    "object": "vendor_profile",    "id": "string",    "name": "string",    "slug": "string",    "brands": [      "string"    ],    "website_domain": "string",    "status": "unclaimed",    "verified": true,    "verified_at": "2019-08-24T14:15:22Z",    "catalogue": "string",    "created_at": "2019-08-24T14:15:22Z"  },  "email": "[email protected]",  "expires_at": "2019-08-24T14:15:22Z",  "usable": true}

List the organisation's claims GET

Every claim the organisation filed, newest first, with its evidence and outcome.

Edit the organisation's brand PATCH

Changes the name, website domain or brand names of the organisation's own profile while it is unverified. A verified profile answers 409: FurniOps changes it on request, since its verification rests on that name and domain.