---
title: "Create segment"
method: POST
path: "/segments"
tags: ["product:chat"]
---

# Create segment

`POST /segments`

Create a segment

## Request body

- CreateSegmentRequest, nullable
  - `all_sender_channels` boolean — If true, all sender channels are included in the segment
  - `all_users` boolean — If true, all users are included in the segment
  - `description` string — The description of the segment (max 256 characters)
  - `filter` object — Filter to apply to the query
  - `id` string — The ID of the segment
  - `name` string — The name of the segment (max 128 characters)
  - `type` 'user' | 'channel', required — The type of the segment

## Response `201`

Response

- CreateSegmentResponse, nullable — Basic response information
  - `duration` string, required — Duration of the request in milliseconds
  - `segment` SegmentResponse
    - `all_sender_channels` boolean, required
    - `all_users` boolean, required
    - `created_at` string, date-time, required
    - `deleted_at` string, date-time, required
    - `description` string, required
    - `filter` object, required
    - `id` string, required
    - `name` string, required
    - `size` integer, required
    - `type` string, required
    - `updated_at` string, date-time, required

## Other responses

- `400` — Bad request
- `429` — Too many requests

---

[API](https://skmtc.net/getstream/apis/stream-api.md) · [All operations](https://skmtc.net/getstream/apis/stream-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/getstream/stream-api/versions/3dba86aaa0d8/schema)