POST
/
integrations
/
{integration_id}
/
relink
{
  "status": "success",
  "data": {
    "link": "<string>"
  }
}

Embed this the same way you would embed the connect link. By default, the link will be valid for 1 hour.

​
Example Request Body

{
  "language": "en",
  "scope_config_id": "9Pv6aCFwNDEzPNmwjSsY9SQx",
  "link_type": "EMBEDDED"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
integration_id
string
required

POST /integrations/:integration_id/relink parameter

Body

application/json
​
language
enum<string> | null
default:
en

Language of the connection flow UI.

Available options:
en,
de,
fr,
it,
es
​
link_type
enum<string>
default:
EMBEDDED

The type of link you want to create. EMBEDDED is for the embedded flow using the Kombo Connect SDK (these links are valid for 1 hour) and MAGIC_LINK is for magic links which you send out manually to customers (there are valid for 1 year).

This defaults to EMBEDDED, which is our recommended method of implementing the connection flow for a seamless user experience.

Available options:
EMBEDDED,
MAGIC_LINK
​
scope_config_id
string | null

Specify a scope config which the integration will start using once the reconnection flow has been completed.

This can be useful if you want to update the permissions of an integration, but only want the change to take effect once the user has updated their API credentials to prevent sync issues.

Response

200 - application/json
​
data
object
required
​
status
enum<string>
required
Available options:
success
Activate integration (optional)Get tools