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

# Edit a segment

> Change a segment you created: its name, description or filters. Leave
out what stays the same. New filters replace the old ones whole and still
need at least 100 simulated users. Once a simulation has used the segment
its filters are locked, so that simulation's results still describe the
same people; you can still rename it.



## OpenAPI

````yaml https://api.semilattice.ai/openapi.json patch /v1/user-models/{segment_id}
openapi: 3.1.0
info:
  title: Semilattice API
  description: >-
    Plan and run simulations of how your users will react to your work, and read
    the results. Everything you create is saved in your Semilattice account, so
    it also appears in the app.


    Authenticate with an API key from **Settings → API Keys** in the app, sent
    as `Authorization: Bearer <key>`.
  contact:
    name: Semilattice API
    url: https://semilattice.ai/
    email: support@semilattice.ai
  version: v1.0.0
servers:
  - url: https://api.semilattice.ai
security:
  - BearerAuth: []
tags:
  - name: Simulations
    description: >-
      A simulation asks one or more user models questions (User Research) or
      sends their simulated users through a page or a flow (User Journey). It is
      planned first, then run once you have checked the plan.
  - name: Projects
    description: >-
      A project groups the simulations about one piece of work, split into
      rounds.
  - name: Rounds
    description: >-
      A round is one version of what you are testing: the document, page or file
      it tests, its simulations, and one synthesis across them.
  - name: Context
    description: >-
      Your context is the background on your company or product that every
      simulation is planned against.
  - name: User Models
    description: >-
      A user model is a simulated version of a specific group of people, built
      from real human data. Every simulation runs against one or more. A segment
      is a user model cut from another by its simulated users' attributes.
  - name: Simulation Schema
    description: >-
      The goals each kind of simulation offers, and what each goal needs from
      you.
paths:
  /v1/user-models/{segment_id}:
    patch:
      tags:
        - User Models
      summary: Edit a segment
      description: >-
        Change a segment you created: its name, description or filters. Leave

        out what stays the same. New filters replace the old ones whole and
        still

        need at least 100 simulated users. Once a simulation has used the
        segment

        its filters are locked, so that simulation's results still describe the

        same people; you can still rename it.
      operationId: edit_segment_route_v1_user_models__segment_id__patch
      parameters:
        - name: segment_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Segment Id
        - name: authorization
          in: header
          required: false
          schema:
            type: string
            title: Authorization
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EditSegmentBody'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    EditSegmentBody:
      properties:
        name:
          anyOf:
            - type: string
              maxLength: 200
            - type: 'null'
          title: Name
        description:
          anyOf:
            - type: string
              maxLength: 2000
            - type: 'null'
          title: Description
        filters:
          anyOf:
            - additionalProperties:
                items:
                  type: string
                type: array
              type: object
            - type: 'null'
          title: Filters
          description: >-
            Replaces the segment's filters whole. Leave it out to keep them.
            Locked once a simulation has used the segment.
      type: object
      title: EditSegmentBody
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.