> ## Documentation Index > Fetch the complete documentation index at: https://promptwatch.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Update Brand Book > Update one or more brand book fields. Omit a field to leave it unchanged. At least one field is required. industry null means Other. An empty analysis instructions value clears it. Renaming also changes the project slug, which the response includes. languageCode, countryCode, and industry must be values from the brand book lists. ## OpenAPI ````yaml /v2/openapi.json patch /brand-book openapi: 3.0.0 info: title: Promptwatch API v2 description: >- API v2 for customer integrations with Promptwatch monitoring platform. This version provides improved structure, additional endpoints, and enhanced functionality. version: 2.0.0 contact: name: Promptwatch Support email: team@promptwatch.com url: https://promptwatch.com license: name: Commercial url: https://promptwatch.com/terms-and-conditions servers: - url: https://server.promptwatch.com/api/v2 description: Promptwatch API v2 security: [] tags: - name: Authentication description: API key validation and authentication - name: Content description: >- AI content generation and content refresh. Create content asynchronously and poll for results. - name: Content Agent description: >- Content Agent (automated content) lifecycle: project settings, scheduled slots, review (accept/decline), and publish. - name: Content Gap description: Content gap analysis and recommendations - name: Publishing description: >- Publish content to a connected CMS, or record a live URL, and track the published page - name: Models description: Available LLM models - name: Monitors description: Monitor management and CRUD operations - name: Page Tracker description: Track URLs and inspect citation stats, responses, and prompts - name: Prompts description: Prompt management and operations - name: Query Fanouts description: ChatGPT query fanout keywords - name: Responses description: LLM response data and analytics - name: Tags description: Tag management for prompts - name: Topics description: Topic management for prompts - name: Actions description: Action items (GEO suggestions and tasks) - name: Personas description: Persona configuration for monitors - name: Brands description: Brand management for competitive analysis - name: Brand Book description: Brand name, website, aliases, and the copy used to describe the brand - name: Visibility description: >- Brand visibility time series, competitor heatmaps, and performance heatmaps - name: Events description: >- Dated project events such as prompts added and actions completed, for annotating time series - name: Citations description: Citation analytics from AI responses - name: Analytics description: Visitor analytics, AI crawler logs, sentiment, and brand visibility trends - name: Search Insights description: >- Google Search Console and Bing Webmaster performance for the project website - name: Projects description: Project management (organization-level keys only) - name: Usage description: Plan usage and limits (organization-level keys only) - name: Sitemap description: Sitemap feeds, crawler settings, crawl progress, and discovered URLs - name: Site Health description: Deprecated. Legacy SEO issue pages. Use Site Audit for the current checks. - name: Site Audit description: >- Site audit runs, issue lists, link and content insights, and per-URL history - name: Socials description: >- Social media citations (Reddit posts, YouTube videos, and LinkedIn posts) found in LLM responses - name: Ads Radar description: Sponsored ads captured in AI answers - name: Shopping description: Product appearances in AI shopping answers and tracked products paths: /brand-book: patch: tags: - Brand Book summary: Update Brand Book description: >- Update one or more brand book fields. Omit a field to leave it unchanged. At least one field is required. industry null means Other. An empty analysis instructions value clears it. Renaming also changes the project slug, which the response includes. languageCode, countryCode, and industry must be values from the brand book lists. operationId: updateBrandBook requestBody: required: true content: application/json: schema: type: object minProperties: 1 additionalProperties: false properties: name: type: string minLength: 1 maxLength: 100 description: Brand name, 1-100 characters. Also updates the project slug. website: type: string minLength: 1 description: Brand website URL, including http:// or https://. aliases: type: array items: type: string description: >- Alternative names for the brand. Replaces the full alias list. languageCode: type: string enum: - 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 description: Language code from the brand book list, for example en-US. countryCode: type: string enum: - 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 description: Country code from the brand book list, for example US. industry: description: Industry from the brand book list. null means Other. type: string enum: - 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 nullable: true shortDescription: type: string nullable: true description: Short summary of the brand. null clears it. description: type: string nullable: true description: Longer description of the brand. null clears it. keyFeatures: type: array items: type: string description: Key features. Replaces the full list. analysisInstructions: type: string nullable: true maxLength: 1000 description: >- How AI engines should describe the brand, up to 1000 characters. null or an empty string clears it. responses: '200': description: Default Response content: application/json: schema: type: object example: projectId: 6ba7b81a-9dad-11d1-80b4-00c04fd430c8 slug: example name: Example website: https://example.com aliases: - Example Co languageCode: en-US countryCode: US shortDescription: A short summary of the brand description: A longer description of the brand industry: Advertising & Marketing keyFeatures: - Fast setup analysisInstructions: null properties: projectId: type: string format: uuid description: Project identifier slug: type: string description: Project URL slug. Changes when the brand name changes. name: type: string description: Brand name website: type: string description: Brand website URL aliases: type: array items: type: string description: Alternative names for the brand languageCode: type: string nullable: true description: >- Language code, for example en-US. Older projects may store a value outside the current list. countryCode: type: string nullable: true description: >- Country code, for example US. Older projects may store a value outside the current list. shortDescription: type: string nullable: true description: Short summary of the brand description: type: string nullable: true description: Longer description of the brand industry: type: string nullable: true description: >- Industry. null means Other. Older projects may store a value outside the current list. keyFeatures: type: array items: type: string description: Key features analysisInstructions: type: string nullable: true description: How AI engines should describe the brand required: - projectId - slug - name - website - aliases - languageCode - countryCode - shortDescription - description - industry - keyFeatures - analysisInstructions additionalProperties: false '400': description: Default Response content: application/json: schema: type: object additionalProperties: true properties: error: type: string description: Error label code: type: string description: Machine-readable error code message: type: string description: Human-readable explanation required: - message '401': description: Default Response content: application/json: schema: type: object example: error: Unauthorized message: Missing or invalid X-API-Key header. properties: error: type: string description: Error category (often aligned with HTTP semantics) code: type: string description: Optional machine-readable code message: type: string description: Human-readable explanation details: type: object description: Optional structured detail (e.g. validation) additionalProperties: true required: - error - message additionalProperties: false '403': description: Default Response content: application/json: schema: type: object additionalProperties: true properties: error: type: string description: Error label code: type: string description: Machine-readable error code message: type: string description: Human-readable explanation required: - message '404': description: Default Response content: application/json: schema: type: object example: code: PROJECT_NOT_FOUND message: Project not found properties: code: type: string enum: - PROJECT_NOT_FOUND - PROJECT_FORBIDDEN - PROJECT_DELETED - PROJECT_SLUG_EMPTY - PROJECT_SLUG_CONFLICT - PROJECT_SLUG_RESERVED - PROJECT_VALIDATION_ERROR - BRANDBOOK_INVALID_WEBSITE - BRANDBOOK_EMPTY_UPDATE - INTERNAL_ERROR description: Machine-readable error code message: type: string description: Human-readable explanation required: - code - message additionalProperties: false '500': description: Default Response content: application/json: schema: type: object example: code: PROJECT_NOT_FOUND message: Project not found properties: code: type: string enum: - PROJECT_NOT_FOUND - PROJECT_FORBIDDEN - PROJECT_DELETED - PROJECT_SLUG_EMPTY - PROJECT_SLUG_CONFLICT - PROJECT_SLUG_RESERVED - PROJECT_VALIDATION_ERROR - BRANDBOOK_INVALID_WEBSITE - BRANDBOOK_EMPTY_UPDATE - INTERNAL_ERROR description: Machine-readable error code message: type: string description: Human-readable explanation required: - code - message additionalProperties: false security: - ApiKeyAuth: [] components: securitySchemes: ApiKeyAuth: type: apiKey in: header name: X-API-Key description: >- API key for authentication. Get yours from the Promptwatch dashboard under Settings > API Keys. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.