POST
/
ats
/
candidates
/
{candidate_id}
/
result-links
{
  "status": "success",
  "data": {}
}

This endpoint is deprecated!

Please use add result link to application 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 action is deprecated because result links usually concern applications and not candidates. Use endpoint nested under /applications instead..

This endpoint requires the permission Add result links to be enabled in your scope config.

​
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": {}
}

Authorizations

​
Authorization
string
headerrequired

Create an API key on the Secrets page in the Kombo dashboard.

Headers

​
X-Integration-Id
string
required

ID of the integration you want to interact with.

Path Parameters

​
candidate_id
string
required

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

Body

application/json
​
label
string
required

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

​
url
string
required

URL of the link.

​
details
object

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
object

Additional fields that we will pass through to specific ATS systems.

Response

200 - application/json
​
status
enum<string>
required
Available options:
success
​
data
object
required
Add attachment to candidateUpdate candidate 🦄