Everyware DocsAPI Base URL
All documentation

Update Customer

Access Endpoint URL: https://rest.everyware.com/api/default/updatecustomer [POST]

Summary

You can use the UpdateCustomer method to change the profile information associated with a particular contact/customer. Either an ExternalID or IndividualID must be provided in order to accurately identify the target within our system. All other parameters are optional.

Inbound Parameters

Parameters should be passed in a single JSON-body object.

Parameter Name Description Optional/Required
FirstName The first name of the contact/customer targeted for the update. Optional
LastName The last name of the contact/customer targeted for the update. Optional
Email The email of the contact/customer targeted for the update. Optional
MobilePhone The mobile phone number (10-digits max, no formatting) of the contact/customer targeted for the update. 
    Example: 3055551212
  </td><td>
    Optional
  </td></tr><tr><td>
    SecondaryPhone
  </td><td>
    A second phone number (10-digits max, no formatting) of the contact/customer targeted for the update.
  </td><td>
    Optional
  </td></tr><tr><td>
    Title
  </td><td>
    The title of the contact/customer targeted for the update.
  </td><td>
    Optional
  </td></tr><tr><td>
    CompanyName
  </td><td>
    The name of the company at which the contact/customer targeted for the update is employed.
  </td><td>
    Optional
  </td></tr><tr><td>
    Address1
  </td><td>
    Line one of the address of the contact/customer targeted for the update.
  </td><td>
    Optional
  </td></tr><tr><td>
    Address2
  </td><td>
    Line two of the address of the contact/customer targeted for the update.
  </td><td>
    Optional
  </td></tr><tr><td>
    City
  </td><td>
    The city in the address of the contact/customer targeted for the update.
  </td><td>
    Optional
  </td></tr><tr><td>
    CountryCode
  </td><td>
    The country code in the address of the contact/customer targeted for the update.  

    Example: United States = US
  </td><td>
    Optional
  </td></tr><tr><td>
    StateCode
  </td><td>
    The state code in the address of the contact/customer targeted for the update.  

    Format: 2-letter code (TX,FL, etc.)
  </td><td>
    Optional
  </td></tr><tr><td>
    PostalCode
  </td><td>
    The postal/zip code in the address of the contact/customer targeted for the update.
  </td><td>
    Optional
  </td></tr><tr><td>
    ListID
  </td><td>
    The ID associated with the list in which the contact/customer targeted for the update can be found.
  </td><td>
    Optional
  </td></tr><tr><td>
    CustomField1
  </td><td>
    Custom field definitions apply to an entire sales site and can be used for various purposes.
  </td><td>
    Optional
  </td></tr><tr><td>
    CustomField2
  </td><td>
    Custom field definitions apply to an entire sales site and can be used for various purposes.
  </td><td>
    Optional
  </td></tr><tr><td>
    CustomField3
  </td><td>
    Custom field definitions apply to an entire sales site and can be used for various purposes.
  </td><td>
    Optional
  </td></tr><tr><td>
    CustomField4
  </td><td>
    Custom field definitions apply to an entire sales site and can be used for various purposes.
  </td><td>
    Optional
  </td></tr><tr><td>
    CustomField5
  </td><td>
    Custom field definitions apply to an entire sales site and can be used for various purposes.
  </td><td>
    Optional
  </td></tr><tr><td>
    CustomField6
  </td><td>
    Custom field definitions apply to an entire sales site and can be used for various purposes.
  </td><td>
    Optional
  </td></tr><tr><td>
    CustomField7
  </td><td>
    Custom field definitions apply to an entire sales site and can be used for various purposes.
  </td><td>
    Optional
  </td></tr><tr><td>
    ExternalID
  </td><td>
    The ID in an external system associated with the contact/customer targeted for the update. Used for tracking customers across systems.
  </td><td>
    * Required  

    Either the ExternalID or IndividualID must be provided.
  </td></tr><tr><td>
    IndividualID
  </td><td>
    The ID in the Everyware system associated with the contact/customer targeted for the update.
  </td><td>
    * Required  

    Either the ExternalID or IndividualID must be provided.
  </td></tr></tbody></table>

Sample Code

{
    "FirstName": "John",
    "LastName": "Smith",
    "Email": "",
    "MobilePhone": "",
    "SecondaryPhone": "",
    "Title": "",
    "CompanyName": "Austin Burritos",
    "Address1": "",
    "Address2": "",
    "City": "Austin",
    "CountryCode": "US",
    "StateCode": "TX",
    "PostalCode": "78702",
    "ListID": "",
    "CustomField1": "",
    "CustomField2": "",
    "CustomField3": "",
    "CustomField4": "",
    "CustomField5": "",
    "CustomField6": "",
    "CustomField7": "",
    "ExternalID": "",
    "IndividualID": "0987643",
}

curl --location 'https://rest.everyware.com/api/Default/UpdateCustomer' \
--header 'Authorization: Basic [xxx]' \
--header 'Content-Type: application/json' \
--data-raw '{
    "FirstName": "John",
    "LastName": "Smith",
    "Email": "",
    "MobilePhone": "",
    "SecondaryPhone": "",
    "Title": "",
    "CompanyName": "Austin Burritos",
    "Address1": "",
    "Address2": "",
    "City": "Austin",
    "CountryCode": "US",
    "StateCode": "TX",
    "PostalCode": "78702",
    "ListID": "",
    "CustomField1": "",
    "CustomField2": "",
    "CustomField3": "",
    "CustomField4": "",
    "CustomField5": "",
    "CustomField6": "",
    "CustomField7": "",
    "ExternalID": "",
    "IndividualID": "0987643",
}'

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