bestmatchCustomers

post https://{your-domain}.com/customer/bestmatch

Find a customer best match based on known Social Information

Details

Every bestmatch field is optional. In most cases, only displayName, screenName, and profileUrl will be present.

Responses and Response Schema

200 (Customers Found)

The 200 response consists of an array[object] consisting of the following fields.

Field Name	Type	Description
id*	string
url*	string Format: uri	The URI the agent can click on to see the customer.
customNonSearchableCustomerFieldOne	string	These will only be present if specified via the /meta/object/customer endpoint.
customNonSearchableCustomerFieldTwo	string	These will only be present if specified via the /meta/object/customer endpoint.
customSearchableCustomerFieldOne	string	These will only be present if specified via the /meta/object/customer endpoint.
customSearchableCustomerFieldTwo	string	These will only be present if specified via the /meta/object/customer endpoint.

400 (Invalid Field in Payload)

An invalid field in the payload. Generic errors.

Field Name	Type	Description
fields	object
error*	string	The name of the error or code.
message*	string	Message passable to the user.

fields object

Field Name	Type
name*	string
errorMessage*	string

401 (API Key is Invalid)

API key is invalid or has become de-authenticated.

500 (Unexpected Error)

Unexpected error.

Field Name	Type	Description
error*	string	Name of the error or code.
message*	string	Message passable to the user.

Body Params

displayName

string

The name of the user as it would appear on the social network.

screenName

string

The social handle of the user.

description

string

A description of the user as specified in Khoros Marketing.

profileUrl

string

A direct link to the user's social profile #header.

email

string

An email address to the user.

phoneNumbers

array of strings

A list of phone numbers for the user as defined in Khoros Marketing.

phoneNumbers

addresses

array of objects

A list of addresses for the user as defined in Khoros Marketing.

addresses

orderNumbers

array of strings

A list of order numbers for the user as defined in Khoros Marketing.

orderNumbers

caseNumbers

array of strings

A list of case numbers for the user as defined in Khoros Marketing. Note: These will not be case numbers from this system.

caseNumbers

accountNumbers

string

A list of account numbers for the user as defined in Khoros Marketing.

Headers

x-sf-user-email

string

The email ID of the Khoros Marketing agent performing the action.

x-sf-initiative

int32

The ID of the active Khoros Marketing initiative the user is in when performing the action.

x-sf-company-id

int32

The Khoros Marketing ID of the company the user is in when making the request.

Responses

Language

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://your-domain.com/customer/bestmatch \
3
     --header 'accept: text/plain' \
4
     --header 'content-type: application/json'

Choose an example:

text/plain