---
title: "Update a segment"
method: PUT
path: "/tenants/{slug}/segments/{slugOrId}"
tags: ["segments"]
---

# Update a segment

`PUT /tenants/{slug}/segments/{slugOrId}`

## Request

- Base URL: `https://api.animam.ai`
- URL: `https://api.animam.ai/tenants/{slug}/segments/{slugOrId}`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`
  - OAuth 2 (authorization code, authorization URL `https://api.animam.ai/oauth/authorize`, token URL `https://api.animam.ai/oauth/token`, scopes: `segments:write`)

Path identifier is `segmentId` (UUID) on the REST endpoint or `slug` via MCP. Both refer to the same segment.

## Path parameters

- `slug` string, required: Tenant slug (URL-safe identifier).
- `slugOrId` string, required: Segment UUID (REST) or slug (MCP).

## Request body

- UpdateSegmentBody
  - `name` string
  - `systemPrompt` string
  - `welcomeMessage` string
  - `formConfig` FormConfig, nullable
    - `enabled` boolean, required
    - `intent` string, required
    - `confirmationMessage` string
    - `fields` FormField[], required
      - `name` string, required
      - `label` string, required
      - `type` 'text' | 'email' | 'phone' | 'textarea', required
      - `required` boolean, required
  - `isActive` boolean

## Response `200`

Updated segment.

- object
  - `segment` SegmentDetail, required
    - `slug` string, required
    - `name` string, required
    - `systemPrompt` string, required
    - `welcomeMessage` string, nullable, required
    - `formConfig` FormConfig, nullable, required
      - `enabled` boolean, required
      - `intent` string, required
      - `confirmationMessage` string
      - `fields` FormField[], required
        - `name` string, required
        - `label` string, required
        - `type` 'text' | 'email' | 'phone' | 'textarea', required
        - `required` boolean, required
    - `isDefault` boolean, required
    - `isActive` boolean, required

---

[API](https://skmtc.dev/animam/apis/animam-api.md) · [All operations](https://skmtc.dev/animam/apis/animam-api/llms.txt) · [OpenAPI document](https://skmtc.dev/animam/apis/animam-api/revisions/138c3cf374f1?raw)