v1

latestOpenAPI 3.0.02026-07-2447166133.5 KB

Contacts

Create an integration link

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

post/contacts/{contactId}/integrationlinks

Path parameters

contactIdstring required

The id of the contact for which the integration link should be created.

Query parameters

type'elation' | 'hint' | 'athena' | 'custom'

Example:elation

The integration type of the existing integration link.

externalIdstring

The id of a contact in an external system.

Example:elation_140797386655555

The id of the contact in the external integrated system.

Headers

s-idempotency-keystring

A unique value generated by the client used to recognize subsequent retries of the same request. Idempotency keys can be up to 255 characters long.

Request body

externalIdstring

The id of a contact in an external system.

type'elation' | 'hint' | 'athena' | 'custom'

urlstring

The URL to the contact in the external system (only for custom integration links).

Example request

{
  "externalId": "elation_140797386655555",
  "type": "elation",
  "url": "https://example.com/contacts/123"
}

Response

created

Example response

{
  "integrationLinks": [
    {
      "contactId": "entity_0E5QDGJC03000",
      "externalId": "elation_140797386655555",
      "type": "elation"
    }
  ]
}