Sign in

v1

latestOpenAPI 3.0.12026-07-24285462499.1 KB
configuration

saves configuration for partner

Endpoint for saving partner's configuration.

put/partner/configuration

Request body

consentUrlstring uri required

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

consentDisplayMode'REDIRECT' | 'POPUP' 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.

assessmentPackageListUrlstring uri required

Refers to Partner API: GET /packages

singleAssessmentPackageUrlstring uri required

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

packageOrderUrlstring uri

Refers to Partner API: POST /packages/orders

inlineAssessmentPackageOrderUrlstring uri

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

oauthTokenUrlstring uri required

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

integrationDisableUrlstring uri

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

supportedAssessmentTypesAssessmentType[] required

Response

Configuration created

consentUrlstring uri required

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

consentDisplayMode'REDIRECT' | 'POPUP' 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.

assessmentPackageListUrlstring uri required

Refers to Partner API: GET /packages

singleAssessmentPackageUrlstring uri required

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

packageOrderUrlstring uri

Refers to Partner API: POST /packages/orders

inlineAssessmentPackageOrderUrlstring uri

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

oauthTokenUrlstring uri required

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

integrationDisableUrlstring uri

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

supportedAssessmentTypesAssessmentType[] required