Skip to main content
PATCH
Update Brand Book

Authorizations

X-API-Key
string
header
required

API key for authentication. Get yours from the Promptwatch dashboard under Settings > API Keys.

Body

application/json
name
string

Brand name, 1-100 characters. Also updates the project slug.

Required string length: 1 - 100
website
string

Brand website URL, including http:// or https://.

Minimum string length: 1
aliases
string[]

Alternative names for the brand. Replaces the full alias list.

languageCode
enum<string>

Language code from the brand book list, for example en-US.

Available options:
en-US,
en-GB,
en-IN,
en-AU,
en-CA,
en-NZ,
nl-NL,
nl-BE,
es-ES,
es-MX,
es-AR,
es-CO,
es-CL,
es-PE,
es-VE,
ca-ES,
fr-FR,
fr-BE,
fr-CA,
de-DE,
de-AT,
de-CH,
cs-CZ,
sk-SK,
sl-SI,
no-NO,
sv-SE,
da-DK,
it-IT,
fi-FI,
pl-PL,
hu-HU,
ro-RO,
lt-LT,
lv-LV,
uk-UA,
el-GR,
tr-TR,
ar-SA,
ar-EG,
ar-AE,
he-IL,
pt-PT,
pt-BR,
ja-JP,
id-ID,
vi-VN,
th-TH,
km-KH,
en-KH,
ko-KR,
hi-IN,
ru-RU,
kk-KZ,
ms-MY,
fil-PH,
zh-SG,
zh-TW,
zh-HK
countryCode
enum<string>

Country code from the brand book list, for example US.

Available options:
US,
CA,
MX,
GB,
IE,
DE,
FR,
ES,
IT,
PT,
NL,
BE,
LU,
AT,
CH,
LI,
MC,
AD,
NO,
SE,
DK,
FI,
IS,
EE,
LV,
LT,
PL,
CZ,
SK,
HU,
RO,
BG,
MD,
UA,
BY,
RU,
GR,
CY,
MT,
TR,
HR,
SI,
RS,
BA,
ME,
MK,
AL,
AZ,
GE,
AM,
JP,
KR,
HK,
TW,
MN,
ID,
TH,
VN,
PH,
MY,
SG,
KH,
IN,
PK,
BD,
KZ,
IL,
AE,
SA,
BH,
OM,
EG,
QA,
KW,
AU,
NZ,
FJ,
PR,
PA,
CR,
BR,
AR,
CL,
CO,
PE,
EC,
VE,
BO,
PY,
UY,
ZA,
NG,
GH,
CI,
SN,
CM,
GN
industry
enum<string> | null

Industry from the brand book list. null means Other.

Available options:
Accounting & Tax,
Advertising & Marketing,
Aerospace & Defense,
Agriculture & Farming,
Architecture & Planning,
Automotive,
Banking,
Beauty & Personal Care,
Biotechnology,
Business Services,
Chemicals,
Cleaning & Maintenance Services,
Construction,
Consulting,
Consumer Electronics,
Consumer Goods,
Cybersecurity,
Data & Analytics,
Developer Tools,
E-commerce Software,
Education,
Energy & Utilities,
Engineering,
Enterprise Software,
Entertainment & Media,
Environmental Services,
Events & Conferences,
Fashion & Apparel,
Financial Services,
Fintech Software,
Food & Beverage,
Gaming,
Government & Public Sector,
Healthcare,
Healthtech Software,
Hospitality,
Human Resources & Recruiting,
HR & Recruiting Software,
Industrial & Manufacturing,
Information Technology,
Infrastructure & Cloud,
Insurance,
Internet & Online Services,
IT Management Software,
Legal Services,
Logistics & Supply Chain,
Luxury Goods,
Machinery & Equipment,
Marketing & Advertising Software,
Market Research,
Mining & Metals,
Nonprofit & Charities,
Oil & Gas,
Pharmaceuticals,
Professional Services,
Productivity & Collaboration Software,
Publishing,
Real Estate,
Restaurants & Food Service,
Retail,
Sales & CRM Software,
Security Services,
Software,
Sports & Fitness,
Telecommunications,
Transportation,
Travel & Tourism,
Venture Capital & Private Equity,
Veterinary & Animal Services,
Waste Management,
Wholesale & Distribution
shortDescription
string | null

Short summary of the brand. null clears it.

description
string | null

Longer description of the brand. null clears it.

keyFeatures
string[]

Key features. Replaces the full list.

analysisInstructions
string | null

How AI engines should describe the brand, up to 1000 characters. null or an empty string clears it.

Maximum string length: 1000

Response

Default Response

projectId
string<uuid>
required

Project identifier

slug
string
required

Project URL slug. Changes when the brand name changes.

name
string
required

Brand name

website
string
required

Brand website URL

aliases
string[]
required

Alternative names for the brand

languageCode
string | null
required

Language code, for example en-US. Older projects may store a value outside the current list.

countryCode
string | null
required

Country code, for example US. Older projects may store a value outside the current list.

shortDescription
string | null
required

Short summary of the brand

description
string | null
required

Longer description of the brand

industry
string | null
required

Industry. null means Other. Older projects may store a value outside the current list.

keyFeatures
string[]
required

Key features

analysisInstructions
string | null
required

How AI engines should describe the brand