KustomerCore.describeCustomer()
Update information about a customer in Kustomer.
First, initialize chat
You must initialize with
KustomerCore.init()before you can execute any additional Core SDK methods
Examples
We're provided some examples of how you can call KustomerCore.describeCustomer():
// Update custom attributes of the customer
KustomeCorer.describeCustomer({
attributes: {
emails: ['[email protected]']
}
});
KustomerCore.describeCustomer({
attributes: {
sharedEmails: ['[email protected]'],
sharedPhones: ['5555555555'],
sharedSocials: [{
username: 'facebook_username',
type: 'facebook'
}]
}
});
// Update custom attributes of the customer and run a callback after
KustomerCore.describeCustomer({
customAttributes: {
some_custom_attribute: 'some custom value'
}
}, function (callbackResponse, error) {
console.log('Updated information about the customer');
});
Syntax
KustomerCore.describeCustomer(options, function(callbackResponse, error))
| Parameter | Type | Description |
|---|---|---|
| options | Object | Required An object containing all of the properties you want to update on the customer inside Kustomer. A breakdown of the options object is listed below. |
| function(callbackResponse, error) | Function | Optional A callback that is run after KustomerCore.describeCustomer() completes. callbackResponse is an object returned to the callback function. See the callbackResponse section below to see the properties of the object.error is either undefined or a native JavaScript Error object. |
options
options{
attributes: {
sharedEmails: ['[email protected]', '[email protected]'],
sharedPhones: ['5555555555', '8888888888'],
sharedSocials: [
{
username: 'facebook_username',
type: 'facebook'
},
{
username: 'twitter_username',
type: 'twitter'
}
]
},
customAttributes: {
some_custom_attribute: 'some_custom_value',
some_custom_attribute2: 'some_custom_value2'
}
}
customAttributesBefore you can update a custom attribute with
KustomerCore.describeCustomer(), the custom attribute must first exist on the Customer Klass in your Kustomer organization.You can learn more about Klasses and custom attributes in the Kustomer Help Center.
| Property | Type | Description |
|---|---|---|
| attributes | Object | Optional An object containing the attributes of a customer. We allow describing emails, phones, or socials. See above for an example payload. |
| customAttributes | Object | Optional An object containing the custom attributes of the customer |
callbackResponse
callbackResponse| Property | Type | Description |
|---|---|---|
| sharedPhones | Array | Required An array of phone number strings. |
| sharedEmails | Array | Required An array of email address strings. |
| sharedSocials | Array | Required An array of objects describing the social media accounts connected to the customer. |
| customerId | String | Required The customer's unique ID in Kustomer's database. |
| custom | Object | Optional An object containing the custom attributes of the customer. { some_custom_attribute: 'some_custom_value' } |
Updated 3 days ago