Create Customer Record

post

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

📘
When to Use This Endpoint
This endpoint is intended for ingesting custom customers data only (Custom Sales Platform). Not supported for Shopify, BigCommerce, or WooCommerce.

📘
How to Update a Custom Customer Record
To update a custom customer record, resend the customer with all of the following fields exactly matching the original:
shop, customer_id, platform, platform_account_id
All other fields will be overwritten with the newly sent values.

Body Params

shop

string

required

customer_id

string

required

platform

string

Defaults to custom-msp

platform_account_id

string

Defaults to custom-msp

address1

string

address2

string

amount_spent

number

city

string

country

string

country_code

string

created_at

date-time

customer_tags

array of strings

Defaults to []

customer_tags

display_name

string

email_address

string

email_marketing_consent_collected_from

string

email_marketing_consent_opt_in_level

string

email_marketing_consent_status

string

email_marketing_consent_updated_at

date-time

first_name

string

last_name

string

last_order_id

string

latitude

number

locale

string

longitude

number

note

string

orders

integer

phone

string

product_subscriber_status

string

sms_marketing_consent_collected_from

string

sms_marketing_consent_opt_in_level

string

sms_marketing_consent_updated_at

date-time

state

string

state_code

string

status

string

tax_exempt

boolean

Defaults to false

zip

string

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

When to Use This Endpoint

How to Update a Custom Customer Record

200Customer record successfully received.

400Bad Request

429Too Many Requests

500Internal Server Error