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

# Update Use Case

> Update an existing use case



## OpenAPI

````yaml post /api/v2/use-case/update
openapi: 3.0.0
info:
  version: 1.0.0
  title: Octave API
  description: API for Octave workspace management and AI-powered content generation
servers:
  - url: https://app.octavehq.com
security:
  - ApiKeyAuth: []
paths:
  /api/v2/use-case/update:
    post:
      tags:
        - Use Case
      summary: Update Use Case
      description: Update an existing use case
      operationId: updateUseCase
      requestBody:
        description: Use case update input
        content:
          application/json:
            schema:
              type: object
              properties:
                oId:
                  type: string
                  minLength: 1
                  description: The ID of the use case to update
                  example: uc_1234
                name:
                  type: string
                  description: The name of the use case
                  example: Lead Generation
                internalName:
                  type: string
                  description: The internal name of the use case
                  example: Lead Gen Process
                description:
                  type: string
                  description: A description of the use case
                  example: Automated lead generation and qualification process
                primaryUrl:
                  type: string
                  format: uri
                  description: The primary URL of the use case
                  example: https://www.example.com/lead-generation
                summary:
                  type: string
                  description: A brief summary of the use case
                  example: Streamlined lead capture and qualification
                scenarios:
                  type: array
                  items:
                    type: string
                  description: Different scenarios where this use case applies
                  example:
                    - New prospect visits website
                    - Existing customer referral
                desiredOutcomes:
                  type: array
                  items:
                    type: string
                  description: The desired outcomes from this use case
                  example:
                    - Qualified leads
                    - Reduced manual work
                    - Higher conversion
                businessDrivers:
                  type: array
                  items:
                    type: string
                  description: Business drivers that motivate this use case
                  example:
                    - Need to scale sales
                    - Reduce acquisition costs
                strategicImpact:
                  type: array
                  items:
                    type: string
                  description: >-
                    The strategic, business-level benefit realized when this use
                    case is solved well: quantifiable impact on revenue, cost,
                    risk, and/or efficiency, and the broader value to the
                    company.
                  example:
                    - Increased revenue growth
                    - Improved market positioning
                customFields:
                  allOf:
                    - $ref: '#/components/schemas/CustomDataFields'
                    - description: Custom fields for additional use case information
                additionalProperties:
                  type: object
                  additionalProperties:
                    anyOf:
                      - type: string
                      - type: array
                        items:
                          type: string
                      - type: number
                      - type: boolean
                  description: >-
                    Workspace-defined additional property values for this use
                    case, keyed by property key.
                  example:
                    tier: Enterprise
                    region: APAC
              required:
                - oId
      responses:
        '200':
          description: Use case updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  _metadata:
                    $ref: '#/components/schemas/Metadata'
                  data:
                    type: object
                    properties:
                      oId:
                        type: string
                        minLength: 1
                        description: The ID of the use case
                        example: uc_1234
                      createdAt:
                        type: string
                        format: date-time
                        description: The date and time the use case was created
                        example: '2021-01-01'
                      updatedAt:
                        type: string
                        nullable: true
                        format: date-time
                        description: The date and time the use case was updated
                        example: '2021-01-01'
                      deletedAt:
                        type: string
                        nullable: true
                        format: date-time
                        description: The date and time the use case was deleted
                        example: '2021-01-01'
                      archivedAt:
                        type: string
                        nullable: true
                        format: date-time
                        description: The date and time the use case was archived
                        example: '2021-01-01'
                      name:
                        type: string
                        nullable: true
                        description: The name of the use case
                        example: Use Case Name
                      internalName:
                        type: string
                        nullable: true
                        description: The internal name of the use case
                        example: Use Case Internal Name
                      description:
                        type: string
                        nullable: true
                        description: The description of the use case
                        example: Use Case Description
                      primaryUrl:
                        type: string
                        nullable: true
                        description: The primary URL of the use case
                        example: https://www.use-case.com
                      active:
                        type: boolean
                        default: true
                        description: Whether the use case is active and can be used
                        example: true
                      data:
                        $ref: '#/components/schemas/UseCaseData'
                      user:
                        type: object
                        properties:
                          oId:
                            type: string
                            nullable: true
                            description: User OId
                          firstName:
                            type: string
                            nullable: true
                            description: >-
                              The first name of the user who created the use
                              case
                            example: John
                          lastName:
                            type: string
                            nullable: true
                            description: The last name of the user who created the use case
                            example: Doe
                      workspace:
                        type: object
                        properties:
                          oId:
                            type: string
                            nullable: true
                            description: Workspace OId
                      scenarios:
                        type: array
                        nullable: true
                        items:
                          type: string
                        description: Scenarios
                      desiredOutcomes:
                        type: array
                        nullable: true
                        items:
                          type: string
                        description: Desired Outcomes
                    required:
                      - oId
                      - createdAt
                      - user
                      - workspace
                required:
                  - _metadata
                  - data
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  _metadata:
                    $ref: '#/components/schemas/Metadata'
                  message:
                    type: string
                required:
                  - _metadata
                  - message
        '404':
          description: Use case not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  _metadata:
                    $ref: '#/components/schemas/Metadata'
                  message:
                    type: string
                required:
                  - _metadata
                  - message
      deprecated: false
components:
  schemas:
    CustomDataFields:
      type: array
      items:
        $ref: '#/components/schemas/CustomDataFieldItem'
    Metadata:
      type: object
      properties:
        usage:
          type: number
          default: 0
          example: 0
          description: API usage
        requestId:
          type: string
          example: requestId
          description: Request ID
        message:
          type: string
          example: message
          description: Message
        timestamp:
          type: string
          example: '2021-01-01T00:00:00.000Z'
          description: Timestamp
      required:
        - requestId
        - timestamp
    UseCaseData:
      type: object
      nullable: true
      properties:
        summary:
          type: string
          nullable: true
          description: Summary
        scenarios:
          type: array
          nullable: true
          items:
            type: string
          description: Scenarios
        desiredOutcomes:
          type: array
          nullable: true
          items:
            type: string
          description: Desired Outcomes
        businessDrivers:
          type: array
          nullable: true
          items:
            type: string
          description: Business Drivers
        strategicImpact:
          type: array
          nullable: true
          items:
            type: string
          description: >-
            The strategic, business-level benefit realized when this use case is
            solved well: quantifiable impact on revenue, cost, risk, and/or
            efficiency, and the broader value to the company.
        customFields:
          $ref: '#/components/schemas/CustomDataFields'
        additionalProperties:
          type: object
          additionalProperties:
            anyOf:
              - type: string
              - type: array
                items:
                  type: string
              - type: number
              - type: boolean
    CustomDataFieldItem:
      type: object
      properties:
        title:
          type: string
        value:
          type: array
          items:
            type: string
      required:
        - title
        - value
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: api_key

````