post_v1-workspaces-workspace-id-data-customers

post

https://data.getangler.ai/v1/workspaces/{workspace_id}/data/customers

Path Params

workspace_id

string

required

Body Params

src

string

enum

Allowed:

dataset_id

string

load_id

string

data

array of objects

required

length between 1 and 500

data*

accepts_marketing

boolean | null

Whether the customer has consented to receive marketing material by email.

accepts_marketing_updated_at

date-time | null

The date and time (ISO 8601 format) when the customer consented or objected to receiving marketing material by email.

addresses

array of objects or null | null

A list of the ten most recently updated addresses for the customer.

addresses

client_id

string | null

The browser or device ID that this customer registration originated from.

currency

string | null

The three-letter code (ISO 4217 format) for the currency that the customer used when they paid for their last order.

created_at

date-time

required

The date and time (ISO 8601 format) when the customer was created.

default_address

object | null

The mailing address associated with the payment method.

string | null

The unique email address of the customer.

hashed_email

string | null

Hashed customer's email in SHA256 (lower case).

hashed_first_name

string | null

Hashed customer's first name in SHA256 (lower case).

hashed_last_name

string | null

Hashed customer's last name in SHA256 (lower case).

hashed_phone

string | null

Hashed customer's phone in SHA256 (lower case).

email_marketing_consent

object | null

The marketing consent information when the customer consented to receiving marketing material by email.

first_name

string | null

The customer's first name.

string

required

length ≥ 1

A unique identifier for the customer.

last_name

string | null

The customer's last name.

last_order_id

string | null

The ID of the customer's last order.

last_order_name

string | null

The name of the customer's last order.

metafield

object | null

Attaches additional metadata to a shop's resources.

marketing_opt_in_level

string | null

The marketing subscription opt-in level, as described in the M3AAWG Sender Best Common Practices, that the customer gave when they consented to receive marketing material by email.

note

string | null

A note about the customer.

orders_count

integer | null

The number of orders associated with this customer.

phone

string | null

The unique phone number (E.164 format) for this customer.

sms_marketing_consent

object | null

The marketing consent information when the customer consented to receiving marketing material by SMS.

state

string | null

enum

The state of the customer's account with a shop.

Allowed:

201Default Response