Segments API reference
Segments endpoints of the Quackback REST API: paths, parameters, request fields and responses.
This is the reference for the Segments endpoints of the Quackback REST API: every endpoint, its parameters, request fields and response fields. It is generated from the API's OpenAPI description, so it matches what the API accepts.
All paths are relative to /api/v1 on your workspace's address (for example https://feedback.example.com/api/v1). Authenticate with an API key in the Authorization: Bearer qb_... header. For keys, errors, pagination and rate limits, see API overview. Every workspace also serves an interactive reference at /api/v1/docs.
Endpoints
POST /segments/{slug}/members: Add users to a segmentDELETE /segments/{slug}/members: Remove users from a segment
Add users to a segment
POST /api/v1/segments/{slug}/members
Adds users to the segment as API-sourced members. A manual assignment is never demoted. Requires the segment.manage permission.
Parameters
Name | In | Type | Required | Description |
|---|---|---|---|---|
| path | string | Yes | Segment slug |
Request body
Field | Type | Required | Description |
|---|---|---|---|
| array of string | Yes | Principals to add or remove. Only human user principals qualify; unknown, anonymous and service principals are reported in failed. |
Response 200: returns added, failed.
Remove users from a segment
DELETE /api/v1/segments/{slug}/members
Removes users from the segment. The body carries the principal IDs. Requires the segment.manage permission.
Parameters
Name | In | Type | Required | Description |
|---|---|---|---|---|
| path | string | Yes | Segment slug |
Request body
Field | Type | Required | Description |
|---|---|---|---|
| array of string | Yes | Principals to add or remove. Only human user principals qualify; unknown, anonymous and service principals are reported in failed. |
Response 200: returns removed, failed.
Was this helpful?
Your feedback shapes what we write next.