> ## Documentation Index > Fetch the complete documentation index at: https://docs.kombo.dev/llms.txt > Use this file to discover all available pages before exploring further. # Add result link to candidate > Add a result link to a candidate. This feature is currently available for the following integrations:

You'd like to see this feature for another integration? Please reach out! We're always happy to discuss extending our coverage. **We recommend to use [add result link to application](/ats/v1/post-applications-application-id-result-links) instead.** This can, for example, be used to link a candidate back to a test result/assessment in your application. As not all ATS tools have a "result link" feature, we sometimes repurpose other fields to expose it. This endpoint requires the permission **Add result links** to be enabled in [your scope config](/scopes). ### Example Request Body ```json { "label": "Assessment Result", "url": "https://example.com/test-results/5BtP1WC1UboS7CF3yxjKcvjG", "details": { "custom_field_name_prefix": "Acme:", "attributes": [ { "key": "Score", "value": "100%" }, { "key": "Time", "value": "2:30h" } ] }, "remote_fields": {} } ``` operationId: PostAtsCandidatesCandidateIdResultLinks parameters: - in: header name: X-Integration-Id schema: type: string description: ID of the integration you want to interact with. example: join:HWUTwvyx2wLoSUHphiWVrp28 required: true - name: candidate_id in: path required: true description: The Kombo ID of the candidate you want to add the result link to. schema: $ref: >- #/components/schemas/PostAtsCandidatesCandidateIdResultLinksParameterCandidateId examples: example1: value: 8Xi6iZrwusZqJmDGXs49GBmJ requestBody: description: POST /ats/candidates/:candidate_id/result-links Request body content: application/json: schema: $ref: >- #/components/schemas/PostAtsCandidatesCandidateIdResultLinksRequestBody examples: example1: value: label: Assessment Result url: https://example.com/test-results/5BtP1WC1UboS7CF3yxjKcvjG details: custom_field_name_prefix: 'Acme:' attributes: - key: Score value: 100% - key: Time value: 2:30h responses: '200': description: POST /ats/candidates/:candidate_id/result-links Positive response content: application/json: schema: $ref: >- #/components/schemas/PostAtsCandidatesCandidateIdResultLinksPositiveResponse default: $ref: '#/components/responses/ErrorResponseATS' x-codeSamples: - lang: python label: PostAtsCandidatesCandidateIdResultLinks source: |- from kombo import Kombo with Kombo( integration_id="workday:HWUTwvyx2wLoSUHphiWVrp28", api_key="", ) as k_client: res = k_client.ats.add_candidate_result_link(candidate_id="8Xi6iZrwusZqJmDGXs49GBmJ", label="Assessment Result", url="https://example.com/test-results/5BtP1WC1UboS7CF3yxjKcvjG", details={ "custom_field_name_prefix": "Acme:", "attributes": [ { "key": "Score", "value": "100%", }, { "key": "Time", "value": "2:30h", }, ], }) # Handle response print(res) - lang: typescript label: PostAtsCandidatesCandidateIdResultLinks source: |- import { Kombo } from "@kombo-api/sdk"; const kombo = new Kombo({ integration_id: "workday:HWUTwvyx2wLoSUHphiWVrp28", api_key: "", }); async function run() { const result = await kombo.ats.addCandidateResultLink({ candidate_id: "8Xi6iZrwusZqJmDGXs49GBmJ", body: { label: "Assessment Result", url: "https://example.com/test-results/5BtP1WC1UboS7CF3yxjKcvjG", details: { custom_field_name_prefix: "Acme:", attributes: [ { key: "Score", value: "100%", }, { key: "Time", value: "2:30h", }, ], }, }, }); console.log(result); } run(); - lang: ruby label: PostAtsCandidatesCandidateIdResultLinks source: >- require 'kombo' Models = ::Kombo::Models s = ::Kombo::Kombo.new( integration_id: 'workday:HWUTwvyx2wLoSUHphiWVrp28', security: Models::Shared::Security.new( api_key: '' ) ) res = s.ats.add_candidate_result_link(candidate_id: '8Xi6iZrwusZqJmDGXs49GBmJ', body: Models::Shared::PostAtsCandidatesCandidateIdResultLinksRequestBody.new( label: 'Assessment Result', url: 'https://example.com/test-results/5BtP1WC1UboS7CF3yxjKcvjG', details: Models::Shared::PostAtsCandidatesCandidateIdResultLinksRequestBodyDetails.new( custom_field_name_prefix: 'Acme:', attributes: [ Models::Shared::PostAtsCandidatesCandidateIdResultLinksRequestBodyAttribute.new( key: 'Score', value: '100%' ), Models::Shared::PostAtsCandidatesCandidateIdResultLinksRequestBodyAttribute.new( key: 'Time', value: '2:30h' ), ] ) )) unless res.post_ats_candidates_candidate_id_result_links_positive_response.nil? # handle response end components: schemas: PostAtsCandidatesCandidateIdResultLinksParameterCandidateId: type: string description: The Kombo ID of the candidate you want to add the result link to. PostAtsCandidatesCandidateIdResultLinksRequestBody: type: object properties: label: type: string description: >- If the system allows us to display a display name for the link, we will use this label. url: type: string format: uri description: URL of the link. details: type: object properties: custom_field_name_prefix: type: string description: >- That will be added to the attribute labels if they are used for custom fields. If you specify `Acme:` as the prefix, the custom field will be named `Acme: Score`. Putting in the name of your company/product is a good idea. attributes: type: array items: type: object properties: key: type: string description: The name of the attribute value: type: string description: The value of the attribute required: - key - value required: - custom_field_name_prefix - attributes description: >- Additional details with attributes that will be added to the result. This can be percentages, scores, or any text. We generally recommend using short attribute keys and a short custom_field_name_prefix to avoid overflowing the ATS UI. remote_fields: allOf: - type: object properties: icims: type: object properties: assessment_package_id: type: string description: >- The package ID of the assessment that the result link will be added to. description: Fields specific to iCIMS. oracle: type: object properties: override_document_category: type: string enum: - IRC_CANDIDATE_RESUME - IRC_CANDIDATE_COVERLETTER - MISC - IRC_INTERNAL description: >- Allows you to override the document category for the url. (Default: MISC) multi_post_to_all_current_applications: type: boolean description: >- If true, the result link will be posted to all current applications for the candidate. description: Fields specific to Oracle. description: >- Additional fields that we will pass through to specific ATS systems. - type: object properties: greenhouse: type: object properties: post_headers: type: object properties: On-Behalf-Of: type: - string - 'null' description: >- ID of the the user that will show up as having performed the action in Greenhouse. We already pass a value by default, but you can use this to override it. description: Headers we will pass with `POST` requests to Greenhouse. description: Fields specific to Greenhouse. workable: type: object properties: on_behalf_of_user_remote_id: type: string description: >- The remote ID of the user that will be displayed in the UI as the one that performed the action. description: Workable specific remote fields for ATS actions. description: >- Additional fields that we will pass through to specific ATS systems. description: Additional fields that we will pass through to specific ATS systems. required: - label - url PostAtsCandidatesCandidateIdResultLinksPositiveResponse: type: object properties: status: type: string const: success data: type: object warnings: type: array items: type: object properties: message: type: string required: - message description: >- These are the interaction warnings that are shown in the dashboard. They are meant to provide debug information to you. We recommend logging them to the console. required: - status - data - warnings responses: ErrorResponseATS: description: The standard error response with the error codes for the ATS use case. content: application/json: schema: type: object properties: status: type: string enum: - error error: type: object properties: code: type: - string - 'null' enum: - PLATFORM.RATE_LIMIT_EXCEEDED - PLATFORM.CONCURRENCY_LIMIT_EXCEEDED - PLATFORM.INTEGRATION_NOT_FOUND - PLATFORM.INPUT_INVALID - PLATFORM.UNKNOWN_ERROR - PLATFORM.IP_NOT_WHITELISTED - PLATFORM.AUTHENTICATION_INVALID - PLATFORM.TASK_TIMED_OUT - INTEGRATION.PERMISSION_MISSING - INTEGRATION.AUTHENTICATION_INVALID - INTEGRATION.QA_FAILED - INTEGRATION.SETUP_SYNC_PENDING - INTEGRATION.SETUP_INCOMPLETE - INTEGRATION.INACTIVE - INTEGRATION.MODEL_NOT_AVAILABLE - INTEGRATION.MODEL_DISABLED - INTEGRATION.ACTION_NOT_AVAILABLE - INTEGRATION.ACTION_DISABLED - REMOTE.SERVICE_UNAVAILABLE - REMOTE.RATE_LIMIT_EXCEEDED - REMOTE.INPUT_INVALID - REMOTE.UNKNOWN_HTTP_ERROR - ATS.JOB_CLOSED - ATS.APPLICATION_ALREADY_EXISTS example: ATS.JOB_CLOSED description: >- Some errors include an error code that can be used to identify their cause. See the [Error Handling Docs](https://docs.kombo.dev/guides/errors) for more information. For your error handling logic please use the error `code` instead of other properties (e.g. message, http status code, ...). title: type: - string - 'null' description: A static, human-readable label. message: type: string description: >- A dynamic, detailed description of what went wrong in this specific instance. log_url: type: - string - 'null' format: uri description: >- The log page in the Kombo UI lists every interaction with full details. If you need assistance, share that link with our support team. required: - code - title - message - log_url description: Error details with structured code for programmatic handling. required: - status - error examples: Error Response: description: >- When building error handling logic, always use the `code` field to identify specific error types programmatically. See the complete list of error codes in the [docs](https://docs.kombo.dev/guides/errors). value: status: error error: code: INTEGRATION.MODEL_NOT_AVAILABLE title: >- This data model isn't supported for the selected integration. message: >- The "employees" model is not yet available for Greenhouse. Please reach out to Kombo if you need this functionality. log_url: https://app.kombo.dev/my-prod/logs?interactionId=123456 Minimal Error Response: description: >- The "message" is always required while other fields can also be `null`. See the [docs](https://docs.kombo.dev/guides/errors) for more information. value: status: error error: code: null title: null message: The message is always in the response. log_url: null securitySchemes: ApiKey: type: http scheme: bearer description: >- Create an API key on the [Secrets](https://app.kombo.dev/secrets) page in the Kombo dashboard. ````