updateCustomer

Update a customer’s details

Details

Responses and Response Schema

201 (Customer Created)

Customer created successfully.

Field NameTypeDescription
id*string
url*string

Format: uri
The URI the agent can click on to see the customer.
customNonSearchableCustomerFieldOnestringThese will only be present if specified via the createCustomer endpoint.
customNonSearchableCustomerFieldTwostringThese will only be present if specified via the createCustomer endpoint.
customSearchableCustomerFieldOnestringThese will only be present if specified via the createCustomer endpoint.
customSearchableCustomerFieldTwostringThese will only be present if specified via the createCustomer endpoint.
400 (Invalid Field in Payload)

Invalid field in payload. Generic errors.

Field NameTypeDescription
fieldsobeject
error*stringThe name of the error or code.
message*stringMessage passable to the user.
fields object
Field NameType
name*string
errorMessage*string
401 (API Key is Invalid)

API key is invalid or has become de-authenticated.

422 (Field Validation Error)

A field validation error has occurred.

Field NameTypeDescription
fieldsarray[object]
error*stringName of error or code.
message*stringMessage passable to the user.
fields object
Field NameTypeDescription
name*string
errorMessage*stringMessage passable to the user.
500 (Unexpected Error)

Unexpected error.

Field NameTypeDescription
error*stringName of the error or code.
message*stringMessage passable to the user.
Path Params
string
required

Customer ID

Body Params
string

An example of a custom field on the Customer object with "searchable": false. These will only be present if specified via the createCustomer endpoint.

string

An example of a custom field on the Customer object with "searchable": false. These will only be present if specified via the createCustomer endpoint.

string

An example of a custom field on the Customer object with "searchable": true. These will only be present if specified via the createCustomer endpoint.

string

An example of a custom field on the Customer object with "searchable": true. These will only be present if specified via the createCustomer endpoint.

Headers
string

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

string

The id of the active Khoros Marketing Initiative the user is in when performing the action.

string

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

Responses

Language
URL
Choose an example:
text/plain