Creating and Importing Customers

Access Endpoint URL: https://rest.everyware.com/api/Default/CreateCustomer [POST]

CreateCustomer creates a new Contact (i.e. individual customer) profile in the context of your Location/Sales Site. The contact is added to the default contact list associated with the location. The MobilePhone must be unique as it will be used to cross-reference what device to send SMS and MMS messages to.

You can also call the CreateMessage endpoint to create a new contact, however the amount of information associated with that contact will be limited.

📘
CreateMessage
Need to send a message quickly while adding a contact?
Use CreateMessage - https://docs.everyware.com/docs/create-message-rest

INBOUND PARAMETERS

Parameter	Description	Required/Not
FirstName	First name of contact/customer to be added	REQUIRED
LastName	Last name of contact/customer to be added	REQUIRED
Email	Email address of contact/customer to be added	Optional
MobilePhone	Mobile phone number of the contact/customer. This is used as Primary Phone for the contact by default. Enter with no formatting, 10 digits max : (305)555-1212 = 3055551212	REQUIRED
SecondaryPhone	Work, home or other alternative phone number for the contact/customer. Enter with no formatting, 10 digits max : (305)555-1212 = 3055551212	Optional
Title	Job Title of contact/customer to be added.	Optional
CompanyName	Doing Business As (DBA) name of the company or location with which the contact should be affiliated.	Optional
Address1	Primary street address for customer	Optional
Address2	Secondary street address for customer (ex: apt, suite number)	Optional
City	City of customer/contact address	Optional
CountryCode	Country for address of customer/contact to be added. "US" = United States	Optional
StateCode	State for address of customer/contact to be added, in two letter format. "TX" = Texas.	Optional
PostalCode	Zip or postal code for contact address	Optional
ListID	The List in which the contact will be placed. All New Contacts will be added to their site’s Default (List) unless specified here otherwise. Note: You can create, edit Lists and view List IDs for a site inside the portal on the Contacts > Manage Lists page.	Optional
CustomField1	Custom field definitions apply to an entire site and can be used for various purposes.	Optional
CustomField2	Custom field definitions apply to an entire site and can be used for various purposes.	Optional
CustomField3	Custom field definitions apply to an entire site and can be used for various purposes.	Optional
CustomField4	Custom field definitions apply to an entire site and can be used for various purposes.	Optional
CustomField5	Custom field definitions apply to an entire site and can be used for various purposes.	Optional
CustomField6	Custom field definitions apply to an entire site and can be used for various purposes.	Optional
CustomField7	Custom field definitions apply to an entire site and can be used for various purposes.	Optional
ExternalID	Unique identifier Everyware can store, optionally. Information will populate the new customer's contact profile CustomerID field.	Optional

🚧
Custom Contact Fields
Everyware offers possible 7 custom contact fields per business. Definitions for each custom field are set at the business level and apply to an entire business. If a custom field is included for a contact here, it will show on the contact's profile and apply wherever the business settings have designated it be used across various Everyware functions.

CreateCustomer Sample Code

{
    "FirstName": "John",
    "LastName": "Doe",
    "Email": "[email protected]",
    "MobilePhone": "3055551212",
    "SecondaryPhone": "5125555555",
    "Title": "Boss",
    "CompanyName": "Test Company",
    "Address1": "123 Main St",
    "Address2": "Apt B",
    "City": "Austin",
    "CountryCode": "US",
    "StateCode": "TX",
    "PostalCode": "78701",
    "ListID": "12345",
    "CustomField1": "Male",
    "CustomField2": "Married",
    "CustomField3": "",
    "CustomField4": "",
    "CustomField5": "",
    "CustomField6": "",
    "CustomField7": "",
    "ExternalID": ""
}

curl --location 'https://rest.everyware.com/api/Default/CreateCustomer' \
--header 'Authorization: Basic [xxx]' \
--header 'Content-Type: application/json' \
--data-raw ' {
 "FirstName": "John",
    "LastName": "Doe",
    "Email": "[email protected]",
    "MobilePhone": "3055551212",
    "SecondaryPhone": "5125555555",
    "Title": "Boss",
    "CompanyName": "Test Company",
    "Address1": "123 Main St",
    "Address2": "Apt B",
    "City": "Austin",
    "CountryCode": "US",
    "StateCode": "TX",
    "PostalCode": "78701",
    "ListID": "12345",
    "CustomField1": "Male",
    "CustomField2": "Married",
    "CustomField3": "",
    "CustomField4": "",
    "CustomField5": "",
    "CustomField6": "",
    "CustomField7": "",
    "ExternalID": ""
}'

{
"IsSuccess": true,
    "Message": "The customer has been successfully created.",
    "Data": 15987118,
    "OrderNumber": "",
    "SMSID": null
}

CreateCustomer Preview Images

When you've successfully added a customer, their Everyware profile is created under the list you specified and with the required data points you provided. You can see the contact in your site under Contacts, then select Edit to review the contact profile details.

1888 — Customer Appears in Contact Lists

1027 — Customer Contact Profile Contains Specified Details