> ## Documentation Index
> Fetch the complete documentation index at: https://chatobserver.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Stage competitor review decisions

> Workspace-scoped app capability through the customer API. MCP requires the matching prompts or competitors permission. Competitor writes require current admin permission. Personal review sessions additionally require user-authorized OAuth and are unavailable to workspace service keys. Identity decisions verify the discovered candidate revision and replay by UUID. Review applications report per-item outcomes; inspect conflicts before continuing.



## OpenAPI

````yaml PATCH /api/v2/brands/reviews/{sessionId}
openapi: 3.1.1
info:
  title: chatobserver public API
  version: '2026-09-09'
  description: >-
    Track AI visibility, manage prompts, inspect collected answers and
    citations, and integrate workspace data with your own tools. Visibility
    endpoints use workspace API keys. Data endpoints use scoped service-account
    keys; spreadsheet client endpoints use authorised client sessions. See the
    authentication guide for each credential type.
  contact:
    name: chatobserver support
    url: https://chatobserver.com/contact
    email: support@chatobserver.com
servers:
  - url: https://app.chatobserver.com
    description: Production API
security:
  - WorkspaceKey: []
  - BearerKey: []
tags:
  - name: Workspace
    description: Validate access and list the workspace project and available platforms.
  - name: Prompts
    description: Create, schedule, organise, activate and retrieve tracked prompts.
  - name: Answers
    description: Retrieve collected AI answers, their analysis and visibility trends.
  - name: Brands
    description: Manage brands and compare their visibility in AI answers.
  - name: Sources and citations
    description: Analyse cited domains, pages and ownership across answers.
  - name: Visitor analytics
    description: Read website visitor and crawler analytics for the workspace.
  - name: Content opportunities
    description: Retrieve content-gap findings and recommendations for tracked prompts.
  - name: Usage
    description: Read workspace consumption and allowance summaries.
  - name: Data connections
    description: Discover authorised connections, source accounts and connector catalogues.
  - name: Data queries
    description: >-
      Create versioned queries, publish definitions and inspect integration
      contracts.
  - name: Data operations
    description: >-
      Execute, validate, cancel and inspect operations and page through result
      rows.
  - name: Data delivery
    description: Manage schedules, transfers, destinations and import workflows.
  - name: Data definitions
    description: Manage reusable definitions and their immutable versions.
  - name: Data webhooks
    description: >-
      Configure event delivery, inspect deliveries, replay events and rotate
      secrets.
  - name: Client authorisation
    description: Authorise spreadsheet clients using a user-approved challenge exchange.
  - name: Spreadsheet clients
    description: >-
      Access document-bound client sessions, queries, schedules, bindings and
      write claims.
  - name: AI visibility audits
    description: Create website visibility audits and retrieve their report links.
  - name: Version 1
    description: Integrate with the version 1 visibility and analytics endpoints.
paths:
  /api/v2/brands/reviews/{sessionId}:
    patch:
      tags:
        - Brands
      summary: Stage competitor review decisions
      description: >-
        Workspace-scoped app capability through the customer API. MCP requires
        the matching prompts or competitors permission. Competitor writes
        require current admin permission. Personal review sessions additionally
        require user-authorized OAuth and are unavailable to workspace service
        keys. Identity decisions verify the discovered candidate revision and
        replay by UUID. Review applications report per-item outcomes; inspect
        conflicts before continuing.
      operationId: patchV2BrandsReviewsSessionId
      parameters:
        - name: sessionId
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: Idempotency-Key
          in: header
          required: false
          schema:
            type: string
            format: uuid
          description: >-
            MCP requires this header. For identity decisions it must match the
            body UUID. Personal review edits use version conflict detection;
            reread after uncertain responses rather than assuming receipt
            replay.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                expectedRevision:
                  type: integer
                  exclusiveMinimum: 0
                decisions:
                  type: array
                  items:
                    type: object
                    properties:
                      candidateKey:
                        type: string
                        minLength: 3
                        maxLength: 600
                      candidateRevision:
                        type: string
                        pattern: ^[a-f0-9]{64}$
                      aliasType:
                        type: string
                        enum:
                          - name
                          - domain
                      aliasText:
                        type: string
                        minLength: 1
                        maxLength: 255
                      normalizedAlias:
                        type: string
                        minLength: 1
                        maxLength: 512
                      action:
                        anyOf:
                          - anyOf:
                              - type: object
                                properties:
                                  kind:
                                    type: string
                                    const: attach
                                  competitorId:
                                    type: integer
                                    exclusiveMinimum: 0
                                required:
                                  - kind
                                  - competitorId
                                additionalProperties: false
                              - type: object
                                properties:
                                  kind:
                                    type: string
                                    const: create
                                  label:
                                    type: string
                                    minLength: 1
                                    maxLength: 150
                                  primaryDomain:
                                    anyOf:
                                      - type: string
                                        maxLength: 255
                                      - type: 'null'
                                  isOwnBrand:
                                    type: boolean
                                required:
                                  - kind
                                additionalProperties: false
                              - type: object
                                properties:
                                  kind:
                                    type: string
                                    const: exclude
                                required:
                                  - kind
                                additionalProperties: false
                          - type: 'null'
                    required:
                      - candidateKey
                      - candidateRevision
                      - aliasType
                      - aliasText
                      - normalizedAlias
                      - action
                    additionalProperties: false
                  minItems: 1
                  maxItems: 500
              required:
                - expectedRevision
                - decisions
              additionalProperties: false
      responses:
        '200':
          description: Successful operation.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      revision:
                        type: number
                      status:
                        type: string
                        enum:
                          - open
                          - applying
                          - completed
                          - abandoned
                      queueRevision:
                        type:
                          - string
                          - 'null'
                      stagedCount:
                        type: number
                      items:
                        type: array
                        items:
                          type: object
                          properties:
                            candidateKey:
                              type: string
                              minLength: 3
                              maxLength: 600
                            candidateRevision:
                              type: string
                              pattern: ^[a-f0-9]{64}$
                            aliasType:
                              type: string
                              enum:
                                - name
                                - domain
                            aliasText:
                              type: string
                              minLength: 1
                              maxLength: 255
                            normalizedAlias:
                              type: string
                              minLength: 1
                              maxLength: 512
                            action:
                              anyOf:
                                - type: object
                                  properties:
                                    kind:
                                      type: string
                                      const: attach
                                    competitorId:
                                      type: integer
                                      exclusiveMinimum: 0
                                  required:
                                    - kind
                                    - competitorId
                                  additionalProperties: false
                                - type: object
                                  properties:
                                    kind:
                                      type: string
                                      const: create
                                    label:
                                      type: string
                                      minLength: 1
                                      maxLength: 150
                                    primaryDomain:
                                      anyOf:
                                        - type: string
                                          maxLength: 255
                                        - type: 'null'
                                    isOwnBrand:
                                      type: boolean
                                  required:
                                    - kind
                                  additionalProperties: false
                                - type: object
                                  properties:
                                    kind:
                                      type: string
                                      const: exclude
                                  required:
                                    - kind
                                  additionalProperties: false
                            status:
                              type: string
                              enum:
                                - staged
                                - applying
                                - applied
                                - conflict
                                - invalid
                                - failed
                            result:
                              anyOf:
                                - type: object
                                  properties:
                                    decisionId:
                                      type: string
                                    candidateKey:
                                      type: string
                                    action:
                                      type: string
                                      enum:
                                        - attach
                                        - create
                                        - exclude
                                    competitorId:
                                      type:
                                        - number
                                        - 'null'
                                    aliasId:
                                      type:
                                        - number
                                        - 'null'
                                    exclusionId:
                                      type:
                                        - number
                                        - 'null'
                                    created:
                                      type: boolean
                                    replayed:
                                      type: boolean
                                    attributedPositions:
                                      type: number
                                    attributedMentions:
                                      type: number
                                    code:
                                      type: string
                                  additionalProperties: false
                                - type: 'null'
                          required:
                            - candidateKey
                            - candidateRevision
                            - aliasType
                            - aliasText
                            - normalizedAlias
                            - action
                            - status
                            - result
                          additionalProperties: false
                      updatedAt:
                        type: string
                    required:
                      - id
                      - revision
                      - status
                      - queueRevision
                      - stagedCount
                      - items
                      - updatedAt
                    additionalProperties: false
                required:
                  - data
                additionalProperties: false
        '400':
          description: Invalid request.
        '403':
          description: Scope, role or personal ownership denied.
        '404':
          description: Record not found.
        '409':
          description: Candidate, review revision or retry conflict.
components:
  securitySchemes:
    WorkspaceKey:
      type: apiKey
      in: header
      name: x-chatobserver-key
      description: >-
        A workspace API key. Data endpoints require a service-account key with
        the specified scopes.
    BearerKey:
      type: http
      scheme: bearer
      description: The workspace or service-account API key as a bearer token.

````