bestmatchCustomers

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.

Language
URL