---
title: "Add result link to application"
method: POST
path: "/ats/applications/{application_id}/result-links"
tags: ["Unified ATS API"]
---

# Add result link to application

`POST /ats/applications/{application_id}/result-links`

Add a result link to an application.

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.

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

### Example Request Body

```json
{
  "application_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"
      }
    ]
  },
  "remote_fields": {}
}
```

## Path parameters

- `application_id` string, required — The Kombo ID of the application you want to create the link for.

## Headers

- `X-Integration-Id` string, required

## Request body

- PostAtsApplicationsApplicationIdResultLinksRequestBody
  - `label` string, required — If we can display a display name for the link, we will use this label.
  - `url` string, uri, 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.
    - `custom_field_name_prefix` string, required — 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` object[], required
      - `key` string, required — The name of the attribute
      - `value` string, required — The value of the attribute
  - `remote_fields` object — Additional fields that we will pass through to specific ATS systems.
    - `icims` object — Fields specific to iCIMS.
      - `assessment_package_id` string — The package ID of the assessment that the result link will be added to.
    - `oracle` object — Fields specific to Oracle.
      - `override_document_category` 'IRC_CANDIDATE_RESUME' | 'IRC_CANDIDATE_COVERLETTER' | 'MISC' | 'IRC_INTERNAL' — Allows you to override the document category for the url. (Default: MISC)
      - `multi_post_to_all_current_applications` boolean — If true, the result link will be posted to all current applications for the candidate.
    - `greenhouse` object — Fields specific to Greenhouse.
      - `post_headers` object — Headers we will pass with `POST` requests to Greenhouse.
        - `On-Behalf-Of` string, nullable — 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.
    - `workable` object — Workable specific remote fields for ATS actions.
      - `on_behalf_of_user_remote_id` string — The remote ID of the user that will be displayed in the UI as the one that performed the action.

## Response `200`

POST /ats/applications/:application_id/result-links Positive response

- PostAtsApplicationsApplicationIdResultLinksPositiveResponse
  - `status` 'success', required
  - `data` object, required
  - `warnings` object[], required — 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.
    - `message` string, required

## Other responses

- `default` — The standard error response with the error codes for the ATS use case.

---

[API](https://skmtc.net/kombo/apis/kombo-api.md) · [All operations](https://skmtc.net/kombo/apis/kombo-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kombo/kombo-api/versions/1e45035b96d3/schema)