Reconnect with connect session

curl --request POST \
  --url https://api.nango.dev/connect/sessions/reconnect \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "connection_id": "<string>",
  "integration_id": "<string>",
  "tags": "<unknown>",
  "end_user": "<unknown>",
  "organization": "<unknown>",
  "integrations_config_defaults": "<unknown>",
  "overrides": "<unknown>",
  "webhook_url_override": "<unknown>"
}
'

import requests

url = "https://api.nango.dev/connect/sessions/reconnect"

payload = {
    "connection_id": "<string>",
    "integration_id": "<string>",
    "tags": "<unknown>",
    "end_user": "<unknown>",
    "organization": "<unknown>",
    "integrations_config_defaults": "<unknown>",
    "overrides": "<unknown>",
    "webhook_url_override": "<unknown>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    connection_id: '<string>',
    integration_id: '<string>',
    tags: '<unknown>',
    end_user: '<unknown>',
    organization: '<unknown>',
    integrations_config_defaults: '<unknown>',
    overrides: '<unknown>',
    webhook_url_override: '<unknown>'
  })
};

fetch('https://api.nango.dev/connect/sessions/reconnect', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.nango.dev/connect/sessions/reconnect",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'connection_id' => '<string>',
    'integration_id' => '<string>',
    'tags' => '<unknown>',
    'end_user' => '<unknown>',
    'organization' => '<unknown>',
    'integrations_config_defaults' => '<unknown>',
    'overrides' => '<unknown>',
    'webhook_url_override' => '<unknown>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.nango.dev/connect/sessions/reconnect"

	payload := strings.NewReader("{\n  \"connection_id\": \"<string>\",\n  \"integration_id\": \"<string>\",\n  \"tags\": \"<unknown>\",\n  \"end_user\": \"<unknown>\",\n  \"organization\": \"<unknown>\",\n  \"integrations_config_defaults\": \"<unknown>\",\n  \"overrides\": \"<unknown>\",\n  \"webhook_url_override\": \"<unknown>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.nango.dev/connect/sessions/reconnect")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"connection_id\": \"<string>\",\n  \"integration_id\": \"<string>\",\n  \"tags\": \"<unknown>\",\n  \"end_user\": \"<unknown>\",\n  \"organization\": \"<unknown>\",\n  \"integrations_config_defaults\": \"<unknown>\",\n  \"overrides\": \"<unknown>\",\n  \"webhook_url_override\": \"<unknown>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.nango.dev/connect/sessions/reconnect")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"connection_id\": \"<string>\",\n  \"integration_id\": \"<string>\",\n  \"tags\": \"<unknown>\",\n  \"end_user\": \"<unknown>\",\n  \"organization\": \"<unknown>\",\n  \"integrations_config_defaults\": \"<unknown>\",\n  \"overrides\": \"<unknown>\",\n  \"webhook_url_override\": \"<unknown>\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "token": "<string>",
    "expires_at": "2023-11-07T05:31:56Z",
    "connect_link": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "errors": [
      {}
    ]
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "errors": [
      {}
    ]
  }
}

Connect

Create a reconnect session

Create a new connect session to reconnect to a specific integration. The token is used like a standard connect session. Only connections created with a connect session are compatible with this endpoint. Use this method when a user needs to input new credentials or to manually refresh token. The connection keeps its connection ID. When the user authorizes, the connection’s tags are replaced by the ones built from tags and end_user. If that leaves no tags, for example when neither is passed or tags is {}, the connection keeps its existing tags.

POST

connect

sessions

reconnect

Reconnect with connect session

curl --request POST \
  --url https://api.nango.dev/connect/sessions/reconnect \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "connection_id": "<string>",
  "integration_id": "<string>",
  "tags": "<unknown>",
  "end_user": "<unknown>",
  "organization": "<unknown>",
  "integrations_config_defaults": "<unknown>",
  "overrides": "<unknown>",
  "webhook_url_override": "<unknown>"
}
'

import requests

url = "https://api.nango.dev/connect/sessions/reconnect"

payload = {
    "connection_id": "<string>",
    "integration_id": "<string>",
    "tags": "<unknown>",
    "end_user": "<unknown>",
    "organization": "<unknown>",
    "integrations_config_defaults": "<unknown>",
    "overrides": "<unknown>",
    "webhook_url_override": "<unknown>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    connection_id: '<string>',
    integration_id: '<string>',
    tags: '<unknown>',
    end_user: '<unknown>',
    organization: '<unknown>',
    integrations_config_defaults: '<unknown>',
    overrides: '<unknown>',
    webhook_url_override: '<unknown>'
  })
};

fetch('https://api.nango.dev/connect/sessions/reconnect', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.nango.dev/connect/sessions/reconnect",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'connection_id' => '<string>',
    'integration_id' => '<string>',
    'tags' => '<unknown>',
    'end_user' => '<unknown>',
    'organization' => '<unknown>',
    'integrations_config_defaults' => '<unknown>',
    'overrides' => '<unknown>',
    'webhook_url_override' => '<unknown>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.nango.dev/connect/sessions/reconnect"

	payload := strings.NewReader("{\n  \"connection_id\": \"<string>\",\n  \"integration_id\": \"<string>\",\n  \"tags\": \"<unknown>\",\n  \"end_user\": \"<unknown>\",\n  \"organization\": \"<unknown>\",\n  \"integrations_config_defaults\": \"<unknown>\",\n  \"overrides\": \"<unknown>\",\n  \"webhook_url_override\": \"<unknown>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.nango.dev/connect/sessions/reconnect")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"connection_id\": \"<string>\",\n  \"integration_id\": \"<string>\",\n  \"tags\": \"<unknown>\",\n  \"end_user\": \"<unknown>\",\n  \"organization\": \"<unknown>\",\n  \"integrations_config_defaults\": \"<unknown>\",\n  \"overrides\": \"<unknown>\",\n  \"webhook_url_override\": \"<unknown>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.nango.dev/connect/sessions/reconnect")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"connection_id\": \"<string>\",\n  \"integration_id\": \"<string>\",\n  \"tags\": \"<unknown>\",\n  \"end_user\": \"<unknown>\",\n  \"organization\": \"<unknown>\",\n  \"integrations_config_defaults\": \"<unknown>\",\n  \"overrides\": \"<unknown>\",\n  \"webhook_url_override\": \"<unknown>\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "token": "<string>",
    "expires_at": "2023-11-07T05:31:56Z",
    "connect_link": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "errors": [
      {}
    ]
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "errors": [
      {}
    ]
  }
}

Requires an API key with the environment:connect_sessions:write scope. Learn more about API key scopes.

Authorizations

Authorization

string

header

required

An Environment API key from your Nango environment, or an Account API key for account-level endpoints.

Body

application/json

connection_id

string

required

integration_id

string

required

Response

Successfully created a connect session

data

object

required

Show child attributes

Getting started

Guides

Reference

Create a reconnect session

Authorizations

Body

Response