CreateCustomer

The CreateCustomer API creates a new Customer (i.e. individual contact) profile with a potentially complete set of details for that contact in the designated Everyware site.

You don’t have to create a customer before you can send them a text message. You can skip CreateCustomer and jump to CreateMessage, which will also create a new customer record, only with fewer details added to theri profile and no message to that customer right away.

Everyware will check for existing customers based on the MobilePhone field. If that phone number already exists in the system, you won't be able to use it again for a new customer.

Access URL: https://rest.everyware.com/api/Default/CreateCustomer

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

Cell 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.

Optional

StateCode

State for address of customer/contact to be added

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 site. Definitions for each custom field are set at the site level and apply to an entire site. If a custom field is included for a contact here, it will show on the contact's profile and apply wherever the site settings have designated it be used across various Everyware functions.

CreateCustomer Sample Codes

{
    "FirstName": "Bob",
    "LastName": "Smith",
    "Email": "[email protected]",
    "MobilePhone": "5555555555",
    "SecondaryPhone": "5125555555",
    "Title": "Boss",
    "CompanyName": "HelloSunshineCompanyNameTest",
    "Address1": "Address1Test",
    "Address2": "Address2Test",
    "City": "CityTest",
    "CountryCode": "CountryCodeTest",
    "StateCode": "TX",
    "PostalCode": "PostalCodeTest",
    "ListID": "147815",
    "CustomField1": "TestCustomField1",
    "CustomField2": "TestCustomField2",
    "CustomField3": "TestCustomField3",
    "CustomField4": "TestCustomField4",
    "CustomField5": "TestCustomField5",
    "CustomField6": "TestCustomFied6",
    "CustomField7": "TestCustomField7",
    "ExternalID": "TestExternalID"
}
{
    "IsSuccess": true,
    "Message": "The customer has been successfully created.",
    "Data": 5848983
}

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.

18881888

Customer Appears in Contact Lists

10271027

Customer Contact Profile Contains Specified Details


Did this page help you?