Headers

Header name Description
Content-Type
required
application/json
X-API-KEY
required
YOUR_API_KEY

Params

Param name Description
data_field
required

Validations:

  • Must be a String

search_option_type
required

Validations:

  • Must be a String

field_id
optional

Validations:

  • Must be a Integer

Examples

// Succesful request
POST /api/v2/user/preference/search_options
{
  "search_option_type": "default",
  "data_field": "metadata.title"
}
200
{
  "search_option": {
    "id": 71,
    "data_field": "metadata.title"
  }
}

Errors

Code Description
401 Unauthorized
404 Not found
500 Internal Server Error
422 Missing parameters