Skip to navigation
RESTAdminManagementCustomer SegmentationShopper Profiles for a Segment

Add Shopper Profiles to Segment

Add Shopper Profiles to a specific Segment.

Limits

  • Limit of Shopper Profiles per request is 50.
  • Limit of 10 concurrent requests.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI NamePermissionParameter
Customersmodifystore_v2_customers
Customersread-onlystore_v2_customers_read_only

NOTE: GET endpoints require only read-only permission, except for the Get All Shopper Profiles in a Segment endpoint which requires modify permission.

Authentication header

HeaderArgumentDescription
X-Auth-Tokenaccess_tokenFor more about API accounts that generate access_tokens, see API Accounts and OAuth Scopes.

Further reading

For example requests and more information about authenticating BigCommerce APIs, see Authentication and Example Requests.

For more about BigCommerce OAuth scopes, see API Accounts and OAuth Scopes.

For a list of API status codes, see API Status Codes.

Path parameters

segmentIdstringRequiredformat: "uuid"

The Segment ID.

store_hashstringRequired
Permanent ID of the BigCommerce store.

Headers

AcceptstringRequiredDefaults to application/json

The MIME type of the response body.

Request

This endpoint expects a list of strings.

Response

An array of Shopper Profiles added to a Segment.

datalist of objectsOptional
errorslist of objectsOptional

Empty on success. Populated when one or more Shopper Profiles could not be added to the Segment.

metaobjectOptional

The number of items (total, successes, failures) in a batch request.

Errors

409
Conflict Error
422
Unprocessable Entity Error