Segments
Get All Segments (Beta)
GET https://api.bigcommerce.com/stores/{store_hash}/v3/segmentsRequest
Returns a paginated Segments List.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
example
Response
Body
object | application/json
Response payload for the BigCommerce API.
dataarray[object]
example
Create Segments (Beta)
POST https://api.bigcommerce.com/stores/{store_hash}/v3/segmentsRequest
Creates Segments.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
Body
array | application/json
Request payload for the BigCommerce API.
example
Response
| An array of created Segments.
Body
object | application/json
Response payload for the BigCommerce API.
dataarray[object]
example
Update Segments (Beta)
PUT https://api.bigcommerce.com/stores/{store_hash}/v3/segmentsRequest
Updates Segments.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
Body
array | application/json
Request payload for the BigCommerce API.
example
Response
An array of created Segments.
Body
object | application/json
Response payload for the BigCommerce API.
dataarray[object]
example
Delete Segments (Beta)
DELETE https://api.bigcommerce.com/stores/{store_hash}/v3/segmentsRequest
Deletes one or more Segments from a store. This will not delete any associated Shopper Profiles.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
example
Response
An empty response.
Did you find what you were looking for?