Customer Segments

Field Definition

Property	Type	Required	Description
sourceCustomerSegmentIds	string[]	Required for tiered rewards	Array containing the customer’s current source-defined segment ID. For this implementation, provide 1 segment value: `Basic`, `Plus`, or `Prime`.

Supported Segment Values

Segment Value	Reward Value
`Basic`	50% of the baseline reward value
`Plus`	100% of the baseline reward value
`Prime`	150% of the baseline reward value

Usage Requirements

Populate sourceCustomerSegmentIds for every customer included in the tiered rewards program.
Provide the customer’s current segment as a single array value.
Submit an updated customer record when the customer moves between segments.
Segment updates may take up to 24 hours to be reflected in the platform.
Reward processing uses the customer segment available at the time the reward is processed.
Redemption and payout files continue to include the final reward value only.

Note: Customers assigned to Basic may receive fewer offers than customers in Plus or Prime. Some offers may not be available when the reduced reward value falls below a merchant’s minimum reward threshold.

Example

{
  "sourceCustomerId": "afa2r21-25f9-4501-b9db-e78afa73c0e3",
  "organizationId": "YOUR_ORGANIZATION_ID",
  "postalCode": "78753",
  "country": "US",
  "customerCreationDate": "2017-01-01T08:00:00Z",
  "enrollmentStartDate": "2023-01-01T08:00:00Z",
  "enrollmentOptInStatus": "ACTIVE",
  "alertOptInStatus": [
    "ALL"
  ],
  "targetingIndicator": "TARGET",
  "sourceCustomerSegmentIds": [
    "Basic"
  ],
  "accounts": [
    {
      "sourceAccountId": "42c57311-25f9-4501-b9db-e78afa73c0e3",
      "sourceCustomerIds": [
        "afa2r21-25f9-4501-b9db-e78afa73c0e3"
      ],
      "primarySourceCustomerId": "afa2r21-25f9-4501-b9db-e78afa73c0e3",
      "status": "OPEN",
      "type": "DDA",
      "sourcePortfolioId": "76afcd28-b494-4b29-b7f2-3eb614a92f97",
      "accountOpenDate": "2018-05-12T20:30:00Z",
      "accountCloseDate": null
    }
  ]
}