saves configuration for partner

put

https://api.smartrecruiters.com/assessment-api/v202010/partner/configuration

Endpoint for saving partner's configuration.

Body Params

consentUrl

uri

required

Refers to Partner API: GET /integration. SmartRecruiters will add URL query parameters: companyId and redirect (only when consentDisplayMode=REDIRECT)

consentDisplayMode

string

enum

required

REDIRECT: End users will leave SmartRecruiters and be redirected to the url configured in consentUrl. POPUP: End users will remain in SmartRecruiters and see a pop up widget.

Allowed:

assessmentPackageListUrl

uri

required

Refers to Partner API: GET /packages

singleAssessmentPackageUrl

uri

required

Refers to Partner API: GET /packages/{assessmentPackageId}

packageOrderUrl

uri

Refers to Partner API: POST /packages/orders

inlineAssessmentPackageOrderUrl

uri

Refers to Partner API: POST /packages/inline/orders

oauthTokenUrl

uri

required

Endpoint to exchange the OAuth 2.0 credentials we received from your service for an access token to your endpoints.

integrationDisableUrl

uri

Refers to Partner API: DELETE com/integrations/companies/{companyId}

fields

array of objects

length ≤ 5

fields

supportedAssessmentTypes

array of objects

required

length between 1 and 6

supportedAssessmentTypes*

Responses

Language

Credentials

OAuth2

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Configuration created

400Invalid configuration provided

401Unauthorized request

403Request missed required scopes