Customers API

Overview

The Customers endpoint supports bulk creation and updates of customer records for a tenant. Each request processes an array of customer objects and applies upsert semantics based on the tenant's identifier configuration.

This endpoint is used to synchronize customer profiles, preferences, and consent attributes from upstream systems into Replenit.

Quick Reference

Endpoints

Parameters

Request

• Body: JSON array of UpsertCustomerDto objects
• Content-Type: application/json

Success Response

• Status: 200 OK
• Body: Response envelope containing data.count

Error Responses

Identifier Behavior

Customer matching is determined by the tenant's identifier priority configuration.

Identifier Priority

Matching Rules

• If the configured identifier exists, the customer record is updated
• If the configured identifier does not exist, a new customer record is created
• Secondary identifiers may be stored but are not used for matching

Example

{
  "CustomerId": "USER-12345",
  "Email": "customer@example.com",
  "Name": "Jane",
  "Surname": "Doe"
}

Identifier Alignment, Usage, and PII Considerations

Request Schema

UpsertCustomerDto

GDPR Processing Flag

Replenit does not infer consent. Responsibility for setting the correct value remains with the data source.

Notes

• Consent flags control downstream activation eligibility
• Language must follow IETF BCP 47 format
• Field requirements may vary based on tenant configuration

Data Completeness & Decision Quality

Replenit's decisioning accuracy improves with broader and richer data across all entities, including users, products, orders, and events.

You are encouraged to send as many fields as possible for every object, as long as the data is:

• Stable – consistently defined over time
• Complete – high coverage across records
• Reliable – not sparsely populated or frequently changing in meaning

While only a subset of fields is required for ingestion, additional attributes directly enhance:

• Profiling accuracy (user, product, and behavioral)
• Contextual understanding for decisioning
• Reasoning quality for all downstream decisions (replenishment, substitution, cross-sell, churn prevention, etc.)

Delete Customer

Parameters

Success Response

{
  "success": true,
  "message": "Customer removed.",
  "data": {
    "customerId": "C-123",
    "deletedAt": "2024-12-22T14:02:49Z"
  }
}

Error Responses

Examples

[
  {
    "CustomerId": "C-126"
  }
]

[
  {
    "Email": "customer@example.com",
    "Language": "fr-FR",
    "GdprOptin": true
  }
]

[
  {
    "CustomerId": "C-123",
    "Email": "john.doe@example.com",
    "Name": "John",
    "Surname": "Doe",
    "Phone": "+1-555-123-4567",
    "Language": "en-US",
    "Username": "johndoe",
    "EmailOptin": true,
    "SmsOptin": false,
    "WhatsappOptin": true,
    "AppPushOptin": true,
    "GdprOptin": true,
    "IsExcluded": false
  }
]

curl -X POST "https://api.replen.it/customers/{tenantId}" \
  -H "Content-Type: application/json" \
  -H "x-replenit-auth-key: YOUR_BASE64_ACCESS_KEY" \
  -d @customers.json

Response Examples

{
  "success": true,
  "message": "Customers saved.",
  "data": {
    "count": 3,
    "processedAt": "2024-12-22T14:05:51Z"
  }
}

{
  "status": 400,
  "errors": {
    "": [
      "At least one of the following properties must have a value: CustomerId, Email"
    ]
  }
}

{
  "status": 400,
  "errors": {
    "[0].CustomerId": [
      "The field CustomerId must be a string with a maximum length of 100."
    ]
  }
}

{
  "success": false,
  "message": "Tenant not found.",
  "data": {}
}