v3

OpenAPI 3.1.02026-07-311255771.3 MB
Unified ATS API

Add result link to candidate

Add a result link to a candidate.

<Warning> **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.

</Warning> <Note> This endpoint requires the permission **Add result links** to be enabled in [your scope config](/scopes). </Note>

Example Request 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"
      }
    ]
  },
  "remote_fields": {}
}
post/ats/candidates/{candidate_id}/result-links

Path parameters

candidate_idstring required

The Kombo ID of the candidate you want to add the result link to.

The Kombo ID of the candidate you want to add the result link to.

Headers

X-Integration-Idstring required

ID of the integration you want to interact with.

Request body

labelstring required

If the system allows us to display a display name for the link, we will use this label.

urlstring uri required

URL of the link.

Response

POST /ats/candidates/:candidate_id/result-links Positive response

status'success' required
dataobject required