Customer

PropertyTypeRequiredDescription
sourceCustomerIdstringRequiredUnique identifier for the customer
organizationIdstringRequiredID of a subsidiary of an institution
postalCodestringRequiredPostal code of the customer's address
countrystringRequiredCountry of the customer's address
customerCreationDatestringRequiredDate and time of customer creation in the publisher's system in ISO-8601 format
enrollmentStartDatestringRequiredDate and time of portfolio enrollment in ISO-8601 format
enrollmentEndDatestringNot requiredDate and time of portfolio enrollment end in ISO-8601 format
enrollmentOptInStatusEnrollmentOptInStatusRequiredPortfolio enrollment status
alertOptInStatusAlertOptInStatus[]RequiredArray representing the customer's offer program alert preferences
targetingIndicatorCustomerTargetingIndicatorRequiredCustomer targeting setting
sourceCustomerSegmentIdsstring[]Not requiredArray of source-defined customer segment identifiers. For tiered rewards, provide 1 segment: Basic, Plus, or Prime.
accountsAccount[]RequiredArray of customer's accounts

Example


{
  "customers": [
    {
      "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",
      "enrollmentEndDate": "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",
            "2e052a88-6ae1-4b78-8d96-f3a037402567"
          ],
          "primarySourceCustomerId": "afa2r21-25f9-4501-b9db-e78afa73c0e3",
          "status": "OPEN",
          "type": "DDA",
          "sourcePortfolioId": "76afcd28-b494-4b29-b7f2-3eb614a92f97",
          "accountOpenDate": "2018-05-12T20:30:00Z",
          "accountCloseDate": null
        }
      ]
    }
  ]
}