POST
/
ats
/
candidates
/
{candidate_id}
/
result-links
curl --request POST \
  --url https://api.kombo.dev/v1/ats/candidates/{candidate_id}/result-links \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Integration-Id: <x-integration-id>' \
  --data '{
  "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"
      }
    ]
  }
}'
{
  "status": "success",
  "data": {}
}

We recommend to 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 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
header
required

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

POST /ats/candidates/:candidate_id/result-links request body

The body is of type object.

Response

200
application/json

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

The response is of type object.