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 |
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 | Optional |
SecondaryPhone | A second phone number (10-digits max, no formatting) of the contact/customer targeted for the update. | Optional |
Title | The title of the contact/customer targeted for the update. | Optional |
CompanyName | The name of the company at which the contact/customer targeted for the update is employed. | Optional |
Address1 | Line one of the address of the contact/customer targeted for the update. | Optional |
Address2 | Line two of the address of the contact/customer targeted for the update. | Optional |
City | The city in the address of the contact/customer targeted for the update. | Optional |
CountryCode | The country code in the address of the contact/customer targeted for the update. Example: United States = US | Optional |
StateCode | The state code in the address of the contact/customer targeted for the update. Format: 2-letter code (TX,FL, etc.) | Optional |
PostalCode | The postal/zip code in the address of the contact/customer targeted for the update. | Optional |
ListID | The ID associated with the list in which the contact/customer targeted for the update can be found. | Optional |
CustomField1 | Custom field definitions apply to an entire sales site and can be used for various purposes. | Optional |
CustomField2 | Custom field definitions apply to an entire sales site and can be used for various purposes. | Optional |
CustomField3 | Custom field definitions apply to an entire sales site and can be used for various purposes. | Optional |
CustomField4 | Custom field definitions apply to an entire sales site and can be used for various purposes. | Optional |
CustomField5 | Custom field definitions apply to an entire sales site and can be used for various purposes. | Optional |
CustomField6 | Custom field definitions apply to an entire sales site and can be used for various purposes. | Optional |
CustomField7 | Custom field definitions apply to an entire sales site and can be used for various purposes. | Optional |
ExternalID | The ID in an external system associated with the contact/customer targeted for the update. Used for tracking customers across systems. | *Required Either the ExternalID or IndividualID must be provided. |
IndividualID | The ID in the Everyware system associated with the contact/customer targeted for the update. | *Required Either the ExternalID or IndividualID must be provided. |
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"
}
Updated 5 months ago