FurniOpsDocs
API referenceBrand

Edit the organisation's brand

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.

  • Scopesbrand:write
  • Rate classwrite
PATCH/v1/brand

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.

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.

Fields to change on an unverified profile

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

application/problem+json

curl -X PATCH "https://example.com/v1/brand" \  -H "Content-Type: application/json" \  -d '{}'
{  "object": "brand",  "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"  },  "editable": true,  "claim": {    "object": "vendor_claim",    "id": "string",    "kind": "listed",    "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"    },    "status": "pending",    "evidence": [      {        "kind": "dns",        "strength": "strong",        "domain": "string",        "org_domain": "string",        "verified_at": "2019-08-24T14:15:22Z",        "last_checked_at": "2019-08-24T14:15:22Z",        "captured_at": "2019-08-24T14:15:22Z"      }    ],    "strength": "strong",    "note": "string",    "message": "string",    "filed_by": "string",    "created_at": "2019-08-24T14:15:22Z",    "checked_at": "2019-08-24T14:15:22Z",    "decided_at": "2019-08-24T14:15:22Z"  }}

Read an invitation to claim a brand POST

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.

Withdraw a claim POST

Withdraws a pending claim. A claim that is not pending answers 409.