Shopper Profiles for a Segment
Get All Shopper Profiles in a Segment (Beta)
GET https://api.bigcommerce.com/stores/{store_hash}/v3/segments/{segmentId}/shopper-profilesRequest
Returns a list of Shopper Profiles that are associated with a given Segment.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
example
Response
An array of Shopper Profiles objects and metadata.
Body
object | application/json
dataarray[object]
example
Add Shopper Profiles to a Segment (Beta)
POST https://api.bigcommerce.com/stores/{store_hash}/v3/segments/{segmentId}/shopper-profilesRequest
Add Shopper Profiles to a specific Segment.
A maximum number of Shopper Profiles per request is 50
, and up to three concurrent requests are allowed.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
Body
array | application/json
A list of Shopper Profiles to associate with the segment.
example
Response
An array of Shopper Profiles added to a Segment.
Body
object | application/json
dataarray[object]
example
Remove Shopper Profiles from a Segment (Beta)
DELETE https://api.bigcommerce.com/stores/{store_hash}/v3/segments/{segmentId}/shopper-profilesRequest
Remove one or more Shopper Profiles that are associated with a Segment. This operation only removes the association; it doesn't delete the 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?