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

# Assign error flavours

> Bulk-assigns the given error flavours to an error (or unassigns them when errorID is
omitted). Flavours not belonging to the project are ignored.

An error never mixes subflow types: the assigned flavours must share one subflow type,
which must match the error's stamped scope (stamped on first assignment, cleared when the
last member is unassigned or moved away). Violations return a validation error.

Required API key permission: `observe:errorFlavours:write`.



## OpenAPI

````yaml /api-reference/openapi/observe.yaml patch /observe/errorFlavours
openapi: 3.1.1
info:
  version: 1.0.0
  title: Corbado API
  description: >
    # Introduction

    This documentation gives an overview of all Corbado API calls to implement
    authentication observe.
  contact:
    name: Corbado team
    email: support@corbado.com
    url: https://www.corbado.com
servers:
  - url: https://api.cloud.corbado.io/v1
security:
  - bearerAuth: []
tags:
  - name: ObserveFlow
    description: Flow search and related APIs
    x-group: Journeys and users
  - name: ObserveSubFlow
    description: Subflow search and related APIs
    x-group: Journeys and users
  - name: ObserveUser
    description: User search and related APIs
    x-group: Journeys and users
  - name: ObserveClientEnv
    description: Client environment search APIs
    x-group: Journeys and users
  - name: ObserveTimeSeries
    description: Time series query APIs
    x-group: Metrics and funnels
  - name: ObserveFunnel
    description: Historical funnel metrics, dictionaries and coverage.
    x-group: Metrics and funnels
  - name: ObserveEvent
    description: Event ingestion and event feed APIs
    x-group: Events
  - name: ObserveError
    description: Named authentication errors and recommendations.
    x-group: Error management
  - name: ObserveErrorFlavour
    description: Error variants and their impact on authentication outcomes.
    x-group: Error management
  - name: ObserveAlert
    description: Authentication alert rules, instances and history.
    x-group: Alert management
  - name: ObserveAnnotation
    description: Annotation APIs (dated notes for analytics context)
    x-group: Annotations
  - name: ObserveTableExport
    description: Table export file listing and download APIs
    x-group: Data exports
  - name: ObserveTimeSeriesExport
    description: Time-series export generation and downloads.
    x-group: Data exports
  - name: ObserveDataExport
    description: Data export APIs
    x-group: User data
  - name: ObserveDataDeletionJob
    description: Data deletion job APIs
    x-group: User data
  - name: ObserveFlowTypeDefinition
    description: Flow type definitions used in authentication journeys.
    x-group: Catalogs and labels
  - name: ObserveCatalog
    description: Catalog APIs
    x-group: Catalogs and labels
  - name: OpenAPI
    description: Downloadable API specification
  - name: ProjectOperationExecution
    description: Project-scoped operation history and pipeline health
  - name: ObserveClassification
    description: Flow and subflow classification APIs
  - name: ObserveIntegrationStats
    description: Integration stats APIs
  - name: ObserveTimeSeriesPrecalculation
    description: Time series precalculation APIs
  - name: ObserveIDList
    x-group: Saved ID lists
    description: Stored ID-list selection APIs
  - name: ObserveDataContext
    description: Schema-loose data context APIs for agent and debugging tooling
  - name: ObserveData
    description: Observe data administration APIs
  - name: ObserveTrackingStats
    description: Tracking ingestion stats APIs
  - name: ObserveExperiment
    x-group: Experiments
    description: Experiment catalog and run APIs
  - name: ObserveDataPolicy
    description: >-
      Project data policy catalogue (retention selected by the SDK's
      meta.dataPolicy code)
  - name: ObserveMetadata
    x-group: Metadata
    description: Authenticator metadata APIs (FIDO MDS + passkey AAGUID)
  - name: ObservePasskey
    x-group: Passkey analysis
    description: Observed passkey search and cohort analysis.
paths:
  /observe/errorFlavours:
    patch:
      tags:
        - ObserveErrorFlavour
      summary: Assign error flavours
      description: >-
        Bulk-assigns the given error flavours to an error (or unassigns them
        when errorID is

        omitted). Flavours not belonging to the project are ignored.


        An error never mixes subflow types: the assigned flavours must share one
        subflow type,

        which must match the error's stamped scope (stamped on first assignment,
        cleared when the

        last member is unassigned or moved away). Violations return a validation
        error.


        Required API key permission: `observe:errorFlavours:write`.
      operationId: ObserveErrorFlavourAssign
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/observeErrorFlavourAssignReq'
      responses:
        '200':
          description: Assignment applied.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/observeErrorFlavourAssignRsp'
        default:
          $ref: '#/components/responses/error'
      security:
        - bearerAuth:
            - observe:errorFlavours:write
components:
  schemas:
    observeErrorFlavourAssignReq:
      type: object
      required:
        - flavourIDs
      properties:
        flavourIDs:
          type: array
          minItems: 1
          maxItems: 1000
          items:
            type: string
            x-oapi-codegen-extra-tags:
              validate: required,id=erf
          description: Flavour IDs to (un)assign (format `erf-<number>`).
          x-oapi-codegen-extra-tags:
            validate: required,min=1,max=1000,dive
        errorID:
          type: string
          description: >-
            Error to assign the flavours to (format `err-<number>`). Omit to
            unassign the flavours.
          x-oapi-codegen-extra-tags:
            validate: omitempty,id=err
        assignSource:
          type: string
          enum:
            - manual
            - kb
            - agent
          description: >-
            Provenance of this assignment (defaults to manual). Only allowed
            together with errorID; unassigning always clears the stored
            provenance.
          x-oapi-codegen-extra-tags:
            validate: excluded_without=ErrorID,omitempty,oneof=manual kb agent
        assignReason:
          type: string
          description: >-
            Human-readable explanation of why these flavours belong to the
            error; stored per flavour and overwritten on remap. Only allowed
            together with errorID.
          x-oapi-codegen-extra-tags:
            validate: excluded_without=ErrorID,omitempty,min=1,max=500
    observeErrorFlavourAssignRsp:
      type: object
      required:
        - assignedCount
      properties:
        assignedCount:
          type: integer
          format: int64
          description: Number of flavours whose assignment was changed.
    errorRspV2:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - message
          properties:
            message:
              description: Error message
              type: string
              example: Validation failed
            details:
              description: Validation error details per field
              type: array
              items:
                type: object
                required:
                  - field
                  - message
                properties:
                  field:
                    description: Field name that failed validation
                    type: string
                    example: projectID
                  message:
                    description: Validation error message
                    type: string
                    example: required
  responses:
    error:
      description: Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/errorRspV2'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Use an Observe API key from the management console. The key selects the
        project and must grant the permission listed on the operation. Keep this
        key on your server.

````