Docs
Management API
Customer segmentation
Shopper Profiles for a Segment

Shopper Profiles for a Segment

Get All Shopper Profiles in a Segment

GET /segments/{segmentId}/shopper-profiles

Request

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

NOTE: The modify Customers OAuth scope is a requirement for this endpoint.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • segmentId in path - string
    required
    The Segment ID.
  • page in query - integer

    Page number.

  • limit in query - integer

    Items count per page.

example

Response

An array of Shopper Profiles objects and metadata.

Body

object | application/json

  • data    array[object]

  • meta    object

    Data about the response including pagination, and collection totals.

example

Add Shopper Profiles to a Segment

POST /segments/{segmentId}/shopper-profiles

Request

Add Shopper Profiles to a specific Segment.

Limits

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

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • segmentId in path - string
    required
    The Segment ID.
  • Content-Type in header with default of application/json - string
    required
    The MIME type of the request body.

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

    • data      array[object]

    example

    Remove Shopper Profiles from a Segment

    DELETE /segments/{segmentId}/shopper-profiles

    Request

    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 header

    Parameters

    • store_hash in path - string
    • Accept in header with default of application/json - string
      required
      The MIME type of the response body.
    • segmentId in path - string
      required
      The Segment ID.
    • id:in in query - array

      Comma separated IDs.

      Type: array[string]

    example

    Response

    An empty response.

    Did you find what you were looking for?
    Delete Shopper ProfilesGet All Shopper Profiles in a Segment