Recommendations

There is the possibility to recommend the customers a product, a service or just an information in CRM CareCloud based on customer purchasing behavior and many other criteria. All recommendations can be viewed by this resource.

Available methods

All available methods for resource recommendations.

HTTP method Endpoint Description
[badge-blue GET] /recommendations List of all recommendations
[badge-blue GET] /recommendations/{recommendation_id} Detail of a recommendation

Get all recommendations

Get the information as a list of all recommendations.
[badge-blue GET] /recommendations

Query string

Parameter name Type Description Mandatory (Yes/No)
count integer The number of records to return.
Default value is 100.
No
offset integer The number of records from a collection to skip.
Default value is 0.
No
sort_field string One of the query string parameters for sorting.
Response is sorted by the specified field.
No
sort_direction string Direction of sorting the response list.
Possible values are: ASC / DESC
No
name string Search recommendations by name No

Response

Status code: 200 OK
Output structure : object

Parameter name Type Description
recommendations Recommendation[] List of recommendations
total_items integer Count of all found recommendations


Get a recommendation

Get information about a specific recommendation
[badge-blue GET] /recommendations/{recommendation_id}

Path parameters

Parameter name Type Description
recommendation_id string The unique id for a recommendation

Response

Status code: 200 OK
Output structure : Recommendation