Beta Programs
Customer Segmentation
Segments

Segments API (Beta)

Get All Segments (Beta)

GET /segments

Request

Returns a paginated Segments List.

Authentication

  • X-Auth-Token in header - required

Parameters

  • store_hash in path - string
  • page in query - integer

    Page number.

  • limit in query - integer

    Items count per page.

  • id:in in query - array

    Comma separated IDs.

example

Response

Body

object | application/json

Response payload for the BigCommerce API.

  • data
    array[object]

  • meta
    object

    Data about the response including pagination, and collection totals.

example

Create Segments (Beta)

POST /segments

Request

Creates Segments.

Authentication

  • X-Auth-Token in header - required

Parameters

  • store_hash in path - string
  • Content-Type in header with default of application/json - string - required

    The MIME type of the request body.

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.

    • data
      array[object]

    • meta
      object

    example

    Update Segments (Beta)

    PUT /segments

    Request

    Updates Segments.

    Authentication

    • X-Auth-Token in header - required

    Parameters

    • store_hash in path - string
    • Content-Type in header with default of application/json - string - required

      The MIME type of the request body.

    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.

      • data
        array[object]

      • meta
        object

      example

      Delete Segments (Beta)

      DELETE /segments

      Request

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

      Authentication

      • X-Auth-Token in header - required

      Parameters

      • store_hash in path - string
      • id:in in query - array

        Comma separated IDs.

      example

      Response

      An empty response.

      Did you find what you were looking for?