---
title: "Create an integration link"
method: POST
path: "/contacts/{contactId}/integrationlinks"
tags: ["Contacts"]
---

# Create an integration link

`POST /contacts/{contactId}/integrationlinks`

This operation creates a link between a contact and an external system with which the Spruce account is integrated.

## Path parameters

- `contactId` string, required

## Query parameters

- `type` 'elation' | 'hint' | 'athena' | 'custom'
- `externalId` string — The id of a contact in an external system.

## Headers

- `s-idempotency-key` string

## Request body

- ContactCreateContactIntegrationLink
  - `externalId` string — The id of a contact in an external system.
  - `type` 'elation' | 'hint' | 'athena' | 'custom'
  - `url` string — The URL to the contact in the external system (only for custom integration links).

## Response `201`

created

- object
  - `integrationLinks` ContactIntegrationLink[], required — Links between a contact and an integrated external system.
    - `contactId` string, required — Spruce's contact ID
    - `externalId` string, required — The id of a contact in an external system.
    - `type` 'elation' | 'hint' | 'athena' | 'custom', required
    - `url` string — The url of a contact in an integrated external system.

## Other responses

- `400` — bad request
- `422` — duplicate request
- `500` — unexpected error

---

[API](https://skmtc.net/sprucehealth/apis/spruce-health-api.md) · [All operations](https://skmtc.net/sprucehealth/apis/spruce-health-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sprucehealth/spruce-health-api/revisions/988e298cd9fd/schema)