The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.

Accept

The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body.

Content-Type

id:in

limit

page

segmentId

shopperProfileId

The error title describing the particular error.


Data about the response including pagination, and collection totals.


Total number of items in the collection response.


The page you are currently on within the collection.


The amount of items returned in the collection per page, controlled by the limit parameter.


Total number of items in the result set.


The total number of pages in the collection.


The date of which the segment was created.


The date of which the segment was updated.


Response payload for the BigCommerce API.


Request payload for the BigCommerce API.


The date and time when the *Shopper Profile* was created.


The ID of the registered *Customer* associated with this *Shopper Profile*.


The date and time when the *Shopper Profile* was last updated.


The ID of a registered Customer to associate with the new *Shopper Profile*.

A list of *Shopper Profiles* to associate with the segment.

### OAuth scopes
| UI Name | Permission | Parameter |
|:--------|:-----------|:----------|
| Customers | modify | `store_v2_customers` |
| Customers | read-only | `store_v2_customers_read_only` |

### Authentication header

| Header | Argument | Description |
|:-------|:---------|:------------|
| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see [API Accounts and OAuth Scopes](/docs/start/authentication). |

### Further reading

For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests).

For more about BigCommerce OAuth scopes, see [API Accounts and OAuth Scopes](/docs/start/authentication#oauth-scopes).

For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes).

X-Auth-Token

BigCommerce

Group customers into segments to offer them promotions and other customized shopping experiences. 

Segments API (Beta)

Deletes one or more *Segments* from a store. This will not delete any associated *Shopper Profiles*.


The *Segment* was not valid. This is the result of either missing required fields, or because of invalid data. See the response for more details.


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*.


Remove Shopper Profiles from a Segment (Beta)

Returns a list of *Shopper Profiles* that are associated with a given *Segment*.

An array of *Shopper Profiles* objects and metadata.


Get All Shopper Profiles in a Segment (Beta)

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.

An array of *Shopper Profiles* added to a *Segment*.

Deletes one or more *Shopper Profiles* from a store.


Returns a paginated *Shopper Profiles* list.

Returns a paginated *Segments* list for a *Shopper Profile*.

An array of *Segments* objects and metadata.


Get All Segments for a Shopper Profile (Beta)

Segments API (Beta)

Get All Segments for a Shopper Profile (Beta)

Request

Authentication

Parameters

example

Response

Body

dataarray[object]

metaobject

example