Details

This endpoint specifies the unique fields available for your Customer and Case objects in your CRM. Each field specified here will be presented to the Khoros Marketing Admin to configure for Khoros Marketing Agent visibility in the Company Settings page.

When enabled, the fields will dictate JSON properties communicated from Khoros to your server. For example, if your Case object specifies:

{
	"name": "case",
	"fields": [
		{
			"name": "clubNo",
			"label": "Customer Club Number",
			"type": "text",
			"searchable": false
		}
	]
}

Then Spredfast will present Customer Club Number as a field to Agents when creating a case, and pass the data onto your server with a payload similar to:

{
	"customerId": "<some id>",
	"title": "Case title",
	"interactions": [...],
	"clubNo": "<specified club number>"
}

Currently, only Customer objects are searchable via Spredfast, therefore any Case fields marked "searchable": true will have no affect on the system.

Responses and Response Schema