> ## 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 Segment

> Update an existing market segment



## OpenAPI

````yaml post /api/v2/segment/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/segment/update:
    post:
      tags:
        - Segment
      summary: Update Segment
      description: Update an existing market segment
      operationId: updateSegment
      requestBody:
        description: Segment update input
        content:
          application/json:
            schema:
              type: object
              properties:
                oId:
                  type: string
                  minLength: 1
                  description: The ID of the segment to update
                  example: sg_1234
                name:
                  type: string
                  description: The name of the segment
                  example: Enterprise Technology Companies
                internalName:
                  type: string
                  description: The internal name of the segment
                  example: EnterpriseTech500Plus
                description:
                  type: string
                  description: A description of the segment
                  example: >-
                    Large technology companies with 500+ employees seeking
                    digital transformation
                strategicFit:
                  type: array
                  items:
                    type: string
                  description: >-
                    Why this segment matters to us: the fit between what we
                    offer and what they need, and the unique attributes of this
                    segment that align to our offering.
                  example:
                    - >-
                      High contract values driven by complex operational
                      requirements.
                    - >-
                      Strong expansion potential as adoption spreads across
                      departments.
                operatingCharacteristics:
                  type: array
                  items:
                    type: string
                  description: >-
                    Internal, qualitative, often inferred traits that
                    distinguish this segment: org structure, maturity, operating
                    model, culture.
                  example:
                    - >-
                      Cross-functional teams with shared ownership of outcomes
                      spanning engineering and operations.
                    - >-
                      Decision-making distributed across technical and business
                      stakeholders.
                buyingDynamics:
                  type: array
                  items:
                    type: string
                  description: >-
                    How this segment makes and acts on purchasing decisions:
                    what drives evaluation, who's involved, how the process
                    runs, and what signals a likely buyer.
                  example:
                    - >-
                      Procurement and security review required before contract
                      signature.
                    - >-
                      Multi-stakeholder evaluation typically driven by an
                      executive sponsor.
                strategicPriorities:
                  type: array
                  items:
                    type: string
                  description: Strategic priorities this segment is pursuing
                  example:
                    - >-
                      Investing in automation to reduce manual operational
                      overhead.
                    - >-
                      Building data infrastructure to support real-time decision
                      making.
                marketPressures:
                  type: array
                  items:
                    type: string
                  description: Market pressures affecting this segment
                  example:
                    - >-
                      Increasing competition from well-funded startups offering
                      point solutions.
                    - >-
                      Regulatory complexity growing across multiple
                      jurisdictions.
                firmographics:
                  type: object
                  properties:
                    industry:
                      type: array
                      items:
                        type: string
                      default: []
                    businessModel:
                      type: array
                      items:
                        type: string
                      default: []
                    geography:
                      type: array
                      items:
                        type: string
                      default: []
                    revenue:
                      type: array
                      items:
                        type: string
                      default: []
                    employees:
                      type: array
                      items:
                        type: string
                      default: []
                  additionalProperties:
                    nullable: true
                  description: >-
                    Structured firmographic data for the segment (industry,
                    businessModel, geography, revenue, employees). Supports
                    custom keys via passthrough.
                customFields:
                  allOf:
                    - $ref: '#/components/schemas/CustomDataFields'
                    - description: Custom fields for additional segment 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
                    segment, keyed by property key.
                  example:
                    tier: Enterprise
                    region: APAC
              required:
                - oId
      responses:
        '200':
          description: Segment updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  _metadata:
                    $ref: '#/components/schemas/Metadata'
                  data:
                    type: object
                    properties:
                      oId:
                        type: string
                      createdAt:
                        type: string
                        nullable: true
                        format: date-time
                      updatedAt:
                        type: string
                        nullable: true
                        format: date-time
                      deletedAt:
                        type: string
                        nullable: true
                        format: date-time
                      archivedAt:
                        type: string
                        nullable: true
                        format: date-time
                      name:
                        type: string
                      internalName:
                        type: string
                      description:
                        type: string
                      active:
                        type: boolean
                        default: true
                      data:
                        type: object
                        nullable: true
                        properties:
                          strategicFit:
                            type: array
                            items:
                              type: string
                            default: []
                          firmographics:
                            type: object
                            properties:
                              industry:
                                type: array
                                items:
                                  type: string
                                default: []
                              businessModel:
                                type: array
                                items:
                                  type: string
                                default: []
                              geography:
                                type: array
                                items:
                                  type: string
                                default: []
                              revenue:
                                type: array
                                items:
                                  type: string
                                default: []
                              employees:
                                type: array
                                items:
                                  type: string
                                default: []
                            default:
                              industry: []
                              businessModel: []
                              geography: []
                              revenue: []
                              employees: []
                            additionalProperties:
                              nullable: true
                          operatingCharacteristics:
                            type: array
                            items:
                              type: string
                            default: []
                          strategicPriorities:
                            type: array
                            items:
                              type: string
                            default: []
                          marketPressures:
                            type: array
                            items:
                              type: string
                            default: []
                          buyingDynamics:
                            type: array
                            items:
                              type: string
                            default: []
                          customFields:
                            $ref: '#/components/schemas/CustomDataFields'
                          additionalProperties:
                            type: object
                            additionalProperties:
                              anyOf:
                                - type: string
                                - type: array
                                  items:
                                    type: string
                                - type: number
                                - type: boolean
                      qualifyingQuestions:
                        type: array
                        nullable: true
                        items:
                          type: object
                          properties:
                            question:
                              type: string
                              description: The question to ask to qualify the entity
                            rationale:
                              type: string
                              description: >-
                                The rationale for the question as to why it
                                helps qualify
                            fitType:
                              type: string
                              enum:
                                - GOOD
                                - BAD
                              description: The fit type of the question
                              example: GOOD
                            weight:
                              type: string
                              enum:
                                - LOW
                                - MEDIUM
                                - HIGH
                                - INSTANT_QUALIFIER
                                - INSTANT_DISQUALIFIER
                              description: The weight of the question
                              example: MEDIUM
                            archivedAt:
                              type: string
                              nullable: true
                              format: date-time
                              description: The date and time the question was archived
                          required:
                            - question
                            - rationale
                            - fitType
                            - weight
                      user:
                        type: object
                        nullable: true
                        properties:
                          oId:
                            type: string
                            nullable: true
                          firstName:
                            type: string
                            nullable: true
                            description: The first name of the user who created the segment
                            example: John
                          lastName:
                            type: string
                            nullable: true
                            description: The last name of the user who created the segment
                            example: Doe
                      workspace:
                        type: object
                        nullable: true
                        properties:
                          oId:
                            type: string
                            nullable: true
                      unrecognized:
                        type: boolean
                      rejected:
                        type: boolean
                      intelOverride:
                        type: object
                        nullable: true
                        properties:
                          enabled:
                            type: boolean
                          cadence:
                            type: string
                            enum:
                              - weekly
                              - biweekly
                              - monthly
                          guidance:
                            type: string
                            nullable: true
                      tags:
                        type: array
                        items:
                          type: object
                          properties:
                            tagGroupOId:
                              type: string
                            tagGroupName:
                              type: string
                            tagOId:
                              type: string
                            tagName:
                              type: string
                          required:
                            - tagGroupOId
                            - tagGroupName
                            - tagOId
                            - tagName
                    required:
                      - oId
                      - createdAt
                      - updatedAt
                      - name
                      - internalName
                      - description
                      - unrecognized
                      - rejected
                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: Segment 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
    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

````