Schema Reference

Use this schema reference to understand what fields are available for one-time CSV imports.

Dates/Timestamps: ISO-8601 (Z/UTC)

Customers

The customers you want to manage in Endear

Column	Name	Type	Required	Unique	Description
first_name	First name	string	No	No	The first name of the customer
last_name	Last name	string	No	No	The last name of the customer
email_address	Email address	string	No	Yes	The email address of the customer
phone_number	Phone number	string	No	Yes	The phone number of the customer
birthday	Birthday	date	No	No	The birthday of the customer
tags	Tags	string-list	No	No	The tags for the customer
default_address_line_1	Address line 1	string	No	No	The first line of the customer's address
default_address_line_2	Address line 2	string	No	No	The second line of the customer's address
default_address_city	City	string	No	No	The city of the customer's address
default_address_province	State/province	string	No	No	The state or province of the customer's address
default_address_postal_code	Postal code	string	No	No	The postal code of the customer's address
default_address_country	Country	string	No	No	The country of the customer's address

Customer assignments

Assignment between customers and staff members

Column	Name	Type	Required	Unique	Description
endear_customer_id	Endear customer ID	string	No	No	The unique identifier for the Endear customer (One of Endear customer ID, Customer email address, Customer phone number or External customer ID is required)
endear_customer_email_address	Customer email address	string	No	No	The email address of the customer (One of Endear customer ID, Customer email address, Customer phone number or External customer ID is required)
endear_customer_phone_number	Customer phone number	string	No	No	The phone number of the customer (One of Endear customer ID, Customer email address, Customer phone number or External customer ID is required)
external_customer_id	External customer ID	string	No	No	The unique identifier for the external customer (One of Endear customer ID, Customer email address, Customer phone number or External customer ID is required)
external_customer_integration_id	External customer integration ID	enum	No	No	The unique identifier for the external customer integration (Required if External customer ID is provided)
endear_user_id	Endear user ID	string	No	No	The unique identifier for the Endear user (One of Endear user ID, Endear user email address, Endear user phone number, Endear user username or External user ID is required)
endear_user_email_address	Endear user email address	string	No	No	The email address of the Endear user (One of Endear user ID, Endear user email address, Endear user phone number, Endear user username or External user ID is required)
endear_user_phone_number	Endear user phone number	string	No	No	The phone number of the Endear user (One of Endear user ID, Endear user email address, Endear user phone number, Endear user username or External user ID is required)
endear_user_username	Endear user username	string	No	No	The username of the Endear user (One of Endear user ID, Endear user email address, Endear user phone number, Endear user username or External user ID is required)
external_user_id	External user ID	string	No	No	The unique identifier for the external user (One of Endear user ID, Endear user email address, Endear user phone number, Endear user username or External user ID is required)
external_user_integration_id	External user integration ID	enum	No	No	The unique identifier for the external user integration (Required if External user ID is provided)
tags	Tags	string-list	No	No	Tags for the customer assignment

Marketing consent

The marketing consent of contacts

Column	Name	Type	Required	Unique	Description
contact	Contact	string	Yes	Yes	The email address or phone number of the contact
status	Consent status	enum	Yes	No	The marketing consent status of the contact

Suppressions

Contacts that have been suppressed

Column	Name	Type	Required	Unique	Description
contact	Contact	string	Yes	Yes	The email address or phone number of the contact
status	Suppression status	enum	Yes	No	The suppression status of the contact

Notes

Notes to attach to customer profiles

Column	Name	Type	Required	Unique	Description
endear_customer_id	Endear customer ID	string	No	No	The unique identifier for the Endear customer (One of Endear customer ID, Customer email address, Customer phone number or External customer ID is required)
customer_email_address	Customer email address	string	No	No	The email address of the customer (One of Endear customer ID, Customer email address, Customer phone number or External customer ID is required)
customer_phone_number	Customer phone number	string	No	No	The phone number of the customer (One of Endear customer ID, Customer email address, Customer phone number or External customer ID is required)
external_customer_id	External customer ID	string	No	No	The unique identifier for the external customer (One of Endear customer ID, Customer email address, Customer phone number or External customer ID is required)
external_customer_integration_id	External customer integration ID	enum	No	No	The unique identifier for the external customer integration (Required if External customer ID is provided)
title	Title	string	No	No	The title of the note
message	Message	string	Yes	No	The body of the note

Staff members

The members of your team that can access Endear

Column	Name	Type	Required	Unique	Description
first_name	First name	string	Yes	No	The first name of the user
last_name	Last name	string	Yes	No	The last name of the user
email_address	Email address	string	No	Yes	The email address of the user
phone_number	Phone number	string	No	Yes	The phone number of the user
username	Username	string	No	Yes	The username of the user
pin	Login pin	string	No	No	The login pin of the user
type	Role	enum	Yes	No	The role of the user
team_ids	Teams	enum-list	No	No	The teams the user should be a member of

Updated about 4 hours ago