API Reference

Create Customer Record

post
https://api.triplewhale.com/api/v2/data-in/customers

Ingest customer data into Triple Whale. This endpoint allows users to upload detailed customer information — including contact details, address, consent status, and purchase history metadata.

Body Params
string
required

The exact Shop URL (e.g., 'example.myshopify.com'). Must match the Shop URL value shown in Settings → Store. The API key owner must also have access to the shop, otherwise the request will return 403.

string
required

The unique identifier for the customer.

string
Defaults to custom-msp

The platform associated with the customer record (e.g. shopify, magento, woocommerce, klaviyo).

string
Defaults to custom-msp

The account ID associated with the platform.

string

The first line of the customer's default address.

string

The second line of the customer's default address.

number

The total amount spent by the customer.

string

The city of the customer's default address.

string

The country of the customer's default address.

string

The country code of the customer’s default address, according to ISO 3166-1 alpha-2.

date-time

The time at which the customer record was created. Must be provided in ISO 8601 format, with explicit timezone information (Z or +/-HH:mm offset). Offsets are supported (e.g., 2024-11-29T12:00:00+02:00). Defaults to the current time.

customer_tags
array of strings
Defaults to

Tags associated with the customer, set in the main sales platform.

customer_tags
string

The display name of the customer.

string

The primary email address associated with the customer’s account.

string

The source from which the customer's email marketing consent was collected.

string

The level of consent provided by the customer for email marketing.

string

The current status of the customer's email marketing consent.

date-time

The time at which the email marketing consent was updated. Must be provided in ISO 8601 format, with explicit timezone information (Z or +/-HH:mm offset). Offsets are supported (e.g., 2024-11-29T12:00:00+02:00).

string

The customer's first name.

string

The customer's last name.

string

The ID of the most recent order from the customer.

number

The latitude associated with the customer's location.

string

The locale setting associated with the customer's account.

number

The longitude associated with the customer's location.

string

Any note attached to the customer profile.

integer

The total number of orders placed by the customer.

string

The customer's phone number.

string

The customer's subscription status for products.

string

The source from which the customer's SMS marketing consent was collected.

string

The level of consent provided by the customer for SMS marketing.

date-time

The time at which the sms marketing consent was updated. Must be provided in ISO 8601 format, with explicit timezone information (Z or +/-HH:mm offset). Offsets are supported (e.g., 2024-11-29T12:00:00+02:00).

string

The state or province of the customer's default address.

string

The state or province code of the customer's default address.

string

The current status of the customer in the system.

boolean
Defaults to false

Indicates whether the customer is exempt from tax.

string

The zip or postal code of the customer's defaults address.

Responses

Updated 2 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago