GEgetstream
product:chat

Create segment

Changed on

Create a segment

post/segments

Request

  • Base URL
    https://chat.stream-io-api.com
  • URL
    https://chat.stream-io-api.com/segments
  • Auth
    • API key in header Authorization and API key in query parameter api_key and API key in header Stream-Auth-Type
    • or API key in query parameter api_key and API key in header Stream-Auth-Type

Request body

all_sender_channelsboolean

If true, all sender channels are included in the segment

all_usersboolean

If true, all users are included in the segment

descriptionstring

The description of the segment (max 256 characters)

filterobject

Filter to apply to the query

idstring

The ID of the segment

namestring

The name of the segment (max 128 characters)

type'user' | 'channel' required

The type of the segment

Response

Response

durationstring required

Duration of the request in milliseconds

Changes