customers--segments
Operations addressed under /customers — 126 operations.
Rendered section: This page contains the segments route group from customers. This is a presentation-only partition; it does not change the API contract or operation tags in the downloadable OpenAPI.
get-customer-segment-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
query Parameters
orderByorderSortpageIndexpageSizeget-customer-segment-list › Responses
Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.
Array of catalog-declared response records.
calculatedScorecustomerIdcustomerSegmentRangeIdendDateidstartDatecreate-customer-segment
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idcreate-customer-segment › Request Body
calculatedScorecustomerSegmentRangeIdendDatestartDatecreate-customer-segment › Responses
Success. The schema is an anyOf over three envelopes: the record, a bare array of it, and a page {total, data[]} carrying the same record.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = array | |
| type = object · requires: data |
idget-customer-current-segment-by-customer-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idget-customer-current-segment-by-customer-id › Responses
Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.
calculatedScorecustomerIdcustomerSegmentRangeIdendDateidstartDateget-customer-segment-by-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idcustomerSegmentIdget-customer-segment-by-id › Responses
Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.
calculatedScorecustomerIdcustomerSegmentRangeIdendDateidstartDateupdate-customer-segment
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idcustomerSegmentIdupdate-customer-segment › Request Body
calculatedScorecustomerSegmentRangeIdendDatestartDateupdate-customer-segment › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.
delete-customer-segment
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idcustomerSegmentIddelete-customer-segment › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.