updateCustomer

patch https://{your-domain}.com/customer/{id}

Update a customer’s details

Details

Responses and Response Schema

201 (Customer Created)

Customer created successfully.

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 createCustomer endpoint.
customNonSearchableCustomerFieldTwo	string	These will only be present if specified via the createCustomer endpoint.
customSearchableCustomerFieldOne	string	These will only be present if specified via the createCustomer endpoint.
customSearchableCustomerFieldTwo	string	These will only be present if specified via the createCustomer endpoint.

400 (Invalid Field in Payload)

Invalid field in payload. Generic errors.

Field Name	Type	Description
fields	obeject
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.

422 (Field Validation Error)

A field validation error has occurred.

Field Name	Type	Description
fields	array[object]
error*	string	Name of error or code.
message*	string	Message passable to the user.

fields object

Field Name	Type	Description
name*	string
errorMessage*	string	Message passable to the user.

500 (Unexpected Error)

Unexpected error.

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

Path Params

string

required

Customer ID

Body Params

customNonSearchableCustomerFieldOne

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.

customNonSearchableCustomerFieldTwo

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.

customSearchableCustomerFieldOne

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.

customSearchableCustomerFieldTwo

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

x-sf-user-email

string

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

x-sf-initiative

string

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

x-sf-company-id

string

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

Responses

Language

URL


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

Choose an example:

text/plain

Details

Responses and Response Schema

201201

400400

401401

422422

500500