---
title: "Update a brand"
method: POST
path: "/v1/finder/brands/{id}"
tags: ["RecruitAffiliates.ai"]
---

# Update a brand

`POST /v1/finder/brands/{id}`

## Request

- Base URL: `https://api.affiliaterail.com`
- URL: `https://api.affiliaterail.com/v1/finder/brands/{id}`
- Auth: HTTP bearer

Each field sent replaces what is there; fields left out are unchanged. Summary, competitors and keywords reach the next weekly scan. Targeting re-scores the brand's prospects before this answers.

**Scope:** `finder:write`

## Path parameters

- `id` string, required: Prefixed id (`fbr_…`)

## Request body

- FinderBrandUpdate
  - `summary` string
  - `country` string
  - `language` string
  - `competitors` object[]: Replaces the list. At most 10.
    - `name` string, required
    - `domain` string, nullable
  - `keywords` string[]: Replaces the list. At most 20.
  - `hashtags` string[]: Replaces the list. At most 20.
  - `targeting` object: Replaces the targeting. Re-scores the brand's prospects straight away.
    - `size_preference` 'any' | 'small' | 'medium' | 'large', required
    - `target_countries` string[], required: ISO 3166-1 alpha-2, upper case
    - `strictness` 'boost' | 'hide', required: `boost` ranks target countries higher; `hide` leaves known other countries out of Discover
    - `languages` string[], required: ISO 639-1

## Response `200`

The updated brand

- FinderBrand
  - `id` string, required: Prefixed id (`fbr_…`)
  - `object` 'finder_brand', required
  - `domain` string, required
  - `name` string, required
  - `country` string, required
  - `language` string, required
  - `summary` string, required
  - `competitors` FinderCompetitor[], required
    - `name` string, required
    - `domain` string, nullable, required
    - `count` integer, nullable, required: How many prospects name this competitor, measured by a scan. Null until one has run.
  - `keywords` string[], required
  - `hashtags` string[], required
  - `targeting` FinderTargeting, required
    - `size_preference` 'any' | 'small' | 'medium' | 'large', required
    - `target_countries` string[], required: ISO 3166-1 alpha-2, upper case
    - `strictness` 'boost' | 'hide', required: `boost` ranks target countries higher; `hide` leaves known other countries out of Discover
    - `languages` string[], required: ISO 639-1
  - `onboarding_completed_at` string, date-time, nullable, required: ISO-8601, UTC
  - `created_at` string, date-time, required: ISO-8601, UTC
  - `updated_at` string, date-time, required: ISO-8601, UTC

## Other responses

- `400`: Invalid request
- `401`: Missing or unknown API key
- `402`: The organization's Recruit Affiliates plan does not include the API
- `403`: Key lacks the required scope
- `404`: No such object in your organization
- `409`: In conflict with the object's state, or the same idempotent request is still running
- `422`: The request was understood and refused
- `429`: Rate limited, by key or by organization: see Retry-After and X-RateLimit-Scope
- `501`: Not available to a test key (`sandbox_no_send`)

---

[API](https://skmtc.dev/affiliaterail/apis/affiliaterail-api.md) · [All operations](https://skmtc.dev/affiliaterail/apis/affiliaterail-api/llms.txt) · [OpenAPI document](https://skmtc.dev/affiliaterail/apis/affiliaterail-api/revisions/ea41f345c092?raw)