PATCH
/
v3
/
resume_search
/
config
Update the config for the logged in user's embeddable resume search tool
curl --request PATCH \
  --url https://{region}.affinda.com/v3/resume_search/config \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "allowPdfDownload": true,
  "maxResults": 10,
  "displayJobTitle": true,
  "displayLocation": true,
  "displayYearsExperience": true,
  "displayOccupationGroup": true,
  "displayEducation": true,
  "displaySkills": true,
  "displayLanguages": true,
  "displayManagementLevel": true,
  "displayKeywords": true,
  "weightJobTitle": 123,
  "weightLocation": 123,
  "weightYearsExperience": 123,
  "weightOccupationGroup": 123,
  "weightEducation": 123,
  "weightSkills": 123,
  "weightLanguages": 123,
  "weightManagementLevel": 123,
  "weightKeywords": 123,
  "indices": [
    "all-resumes",
    "my-index"
  ],
  "showIndexDropdown": true,
  "searchToolTheme": {
    "palette": {
      "mode": "light",
      "background": "<string>",
      "text": {
        "primary": "<string>",
        "secondary": "<string>",
        "disabled": "<string>"
      },
      "divider": "<string>",
      "primary": {
        "main": "<string>",
        "light": "<string>",
        "dark": "<string>",
        "contrastText": "<string>"
      },
      "secondary": {
        "main": "<string>",
        "light": "<string>",
        "dark": "<string>",
        "contrastText": "<string>"
      },
      "success": {
        "main": "<string>",
        "light": "<string>",
        "dark": "<string>",
        "contrastText": "<string>"
      },
      "annotation": {
        "main": "<string>",
        "light": "<string>",
        "dark": "<string>",
        "contrastText": "<string>"
      },
      "error": {
        "main": "<string>",
        "light": "<string>",
        "dark": "<string>",
        "contrastText": "<string>"
      },
      "info": {
        "main": "<string>",
        "light": "<string>",
        "dark": "<string>",
        "contrastText": "<string>"
      },
      "warning": {
        "main": "<string>",
        "light": "<string>",
        "dark": "<string>",
        "contrastText": "<string>"
      }
    },
    "typography": {
      "fontFamily": "<string>",
      "fontSize": "<string>",
      "fontWeightRegular": "<string>",
      "fontWeightMedium": "<string>",
      "fontWeightBold": "<string>"
    },
    "borderRadius": 123,
    "fontUrl": "<string>"
  },
  "actions": [
    {
      "label": "Add to shortlist",
      "eventName": "addToShortlist"
    }
  ],
  "hideToolbar": true,
  "hideSidePanel": true,
  "customFieldsConfig": [
    {
      "dataPoint": "RdNAniIH",
      "weight": 0.5
    }
  ],
  "distanceUnit": "km"
}'
{
  "allowPdfDownload": true,
  "maxResults": 10,
  "displayJobTitle": true,
  "displayLocation": true,
  "displayYearsExperience": true,
  "displayOccupationGroup": true,
  "displayEducation": true,
  "displaySkills": true,
  "displayLanguages": true,
  "displayManagementLevel": true,
  "displayKeywords": true,
  "weightJobTitle": 123,
  "weightLocation": 123,
  "weightYearsExperience": 123,
  "weightOccupationGroup": 123,
  "weightEducation": 123,
  "weightSkills": 123,
  "weightLanguages": 123,
  "weightManagementLevel": 123,
  "weightKeywords": 123,
  "indices": [
    "all-resumes",
    "my-index"
  ],
  "showIndexDropdown": true,
  "searchToolTheme": {
    "palette": {
      "mode": "light",
      "background": "<string>",
      "text": {
        "primary": "<string>",
        "secondary": "<string>",
        "disabled": "<string>"
      },
      "divider": "<string>",
      "primary": {
        "main": "<string>",
        "light": "<string>",
        "dark": "<string>",
        "contrastText": "<string>"
      },
      "secondary": {
        "main": "<string>",
        "light": "<string>",
        "dark": "<string>",
        "contrastText": "<string>"
      },
      "success": {
        "main": "<string>",
        "light": "<string>",
        "dark": "<string>",
        "contrastText": "<string>"
      },
      "annotation": {
        "main": "<string>",
        "light": "<string>",
        "dark": "<string>",
        "contrastText": "<string>"
      },
      "error": {
        "main": "<string>",
        "light": "<string>",
        "dark": "<string>",
        "contrastText": "<string>"
      },
      "info": {
        "main": "<string>",
        "light": "<string>",
        "dark": "<string>",
        "contrastText": "<string>"
      },
      "warning": {
        "main": "<string>",
        "light": "<string>",
        "dark": "<string>",
        "contrastText": "<string>"
      }
    },
    "typography": {
      "fontFamily": "<string>",
      "fontSize": "<string>",
      "fontWeightRegular": "<string>",
      "fontWeightMedium": "<string>",
      "fontWeightBold": "<string>"
    },
    "borderRadius": 123,
    "fontUrl": "<string>"
  },
  "userId": 1234,
  "username": "big.smoke",
  "actions": [
    {
      "label": "Add to shortlist",
      "eventName": "addToShortlist"
    }
  ],
  "hideToolbar": true,
  "hideSidePanel": true,
  "customFieldsConfig": [
    {
      "dataPoint": "RdNAniIH",
      "weight": 0.5
    }
  ],
  "distanceUnit": "km"
}

Authorizations

Authorization
string
header
required

Basic authentication using an API key, e.g. {Authorization: Bearer aff_0bb4fbdf97b7e4111ff6c0015471094155f91}. You can find your API key within the Settings page of the Affinda web app. You can obtain an API key by signing up for a free trial.

Body

application/json
allowPdfDownload
boolean
maxResults
integer | null

Maximum number of results that can be returned. Setting to "null" means no limitation.

Required range: x >= 1
Example:

10

displayJobTitle
boolean
displayLocation
boolean
displayYearsExperience
boolean
displayOccupationGroup
boolean
displayEducation
boolean
displaySkills
boolean
displayLanguages
boolean
displayManagementLevel
boolean
displayKeywords
boolean
weightJobTitle
number
weightLocation
number
weightYearsExperience
number
weightOccupationGroup
number
weightEducation
number
weightSkills
number
weightLanguages
number
weightManagementLevel
number
weightKeywords
number
indices
string[]

List of index names.

Example:
["all-resumes", "my-index"]
showIndexDropdown
boolean | null

Controls whether or not the index dropdown is displayed to the user

searchToolTheme
object

Customize the theme of the embeded search tool.

actions
object[] | null

A list of actions to show in the dropdown in the embedded search tool

hideToolbar
boolean

Hide the reset/import toolbar.

hideSidePanel
boolean

Hide the entire side panel.

customFieldsConfig
object[] | null
distanceUnit
enum<string>

The unit of distance to use for location based searches

Available options:
mi,
km
Example:

"km"

Response

Successfully updated configurations.

allowPdfDownload
boolean
maxResults
integer | null

Maximum number of results that can be returned. Setting to "null" means no limitation.

Required range: x >= 1
Example:

10

displayJobTitle
boolean
displayLocation
boolean
displayYearsExperience
boolean
displayOccupationGroup
boolean
displayEducation
boolean
displaySkills
boolean
displayLanguages
boolean
displayManagementLevel
boolean
displayKeywords
boolean
weightJobTitle
number
weightLocation
number
weightYearsExperience
number
weightOccupationGroup
number
weightEducation
number
weightSkills
number
weightLanguages
number
weightManagementLevel
number
weightKeywords
number
indices
string[]

List of index names.

Example:
["all-resumes", "my-index"]
showIndexDropdown
boolean | null

Controls whether or not the index dropdown is displayed to the user

searchToolTheme
object

Customize the theme of the embeded search tool.

userId
integer

ID of the logged in user.

Required range: x >= 1
Example:

1234

username
string

Username of the logged in user.

Example:

"big.smoke"

actions
object[] | null

A list of actions to show in the dropdown in the embedded search tool

hideToolbar
boolean

Hide the reset/import toolbar.

hideSidePanel
boolean

Hide the entire side panel.

customFieldsConfig
object[] | null
distanceUnit
enum<string>

The unit of distance to use for location based searches

Available options:
mi,
km
Example:

"km"