Skip to main content
POST
Create recommendation
Replace {your-subdomain} with your workspace’s subdomain.
Learn how to find your subdomain in Workspace subdomain.

Headers

X-Api-Key
string
default:your-api-key
required

Use the X-Api-Key header to provide your workspace API key. Refer to Authentication for more information.

Body

application/json
title
string
required

Unique in the workspace, ignoring case.

Example:

"Refunds"

url
string
required

Unique in the workspace, ignoring case. Must be a valid regular expression when matching_criteria is regex.

Example:

"/refund"

matching_criteria
enum<string>
default:contains
Available options:
contains,
exact_match,
regex
entities
object[]

Articles and categories the recommendation shows. They must belong to the workspace.

Response

Created - Recommendation created

recommendation
object