Update an integration

Edit an integration

PATCH /integrations/{uniqueKey}

Edit an integration

cURL

curl --request PATCH \
  --url https://api.nango.dev/integrations/{uniqueKey} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "unique_key": "<string>",
  "display_name": "<string>",
  "forward_webhooks": true,
  "credentials": {
    "client_id": "<string>",
    "client_secret": "<string>",
    "scopes": "<string>",
    "webhook_secret": "<string>"
  },
  "integration_config": {}
}
'

import requests

url = "https://api.nango.dev/integrations/{uniqueKey}"

payload = {
    "unique_key": "<string>",
    "display_name": "<string>",
    "forward_webhooks": True,
    "credentials": {
        "client_id": "<string>",
        "client_secret": "<string>",
        "scopes": "<string>",
        "webhook_secret": "<string>"
    },
    "integration_config": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    unique_key: '<string>',
    display_name: '<string>',
    forward_webhooks: true,
    credentials: {
      client_id: '<string>',
      client_secret: '<string>',
      scopes: '<string>',
      webhook_secret: '<string>'
    },
    integration_config: {}
  })
};

fetch('https://api.nango.dev/integrations/{uniqueKey}', 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/integrations/{uniqueKey}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'unique_key' => '<string>',
    'display_name' => '<string>',
    'forward_webhooks' => true,
    'credentials' => [
        'client_id' => '<string>',
        'client_secret' => '<string>',
        'scopes' => '<string>',
        'webhook_secret' => '<string>'
    ],
    'integration_config' => [
        
    ]
  ]),
  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/integrations/{uniqueKey}"

	payload := strings.NewReader("{\n  \"unique_key\": \"<string>\",\n  \"display_name\": \"<string>\",\n  \"forward_webhooks\": true,\n  \"credentials\": {\n    \"client_id\": \"<string>\",\n    \"client_secret\": \"<string>\",\n    \"scopes\": \"<string>\",\n    \"webhook_secret\": \"<string>\"\n  },\n  \"integration_config\": {}\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.nango.dev/integrations/{uniqueKey}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"unique_key\": \"<string>\",\n  \"display_name\": \"<string>\",\n  \"forward_webhooks\": true,\n  \"credentials\": {\n    \"client_id\": \"<string>\",\n    \"client_secret\": \"<string>\",\n    \"scopes\": \"<string>\",\n    \"webhook_secret\": \"<string>\"\n  },\n  \"integration_config\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.nango.dev/integrations/{uniqueKey}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"unique_key\": \"<string>\",\n  \"display_name\": \"<string>\",\n  \"forward_webhooks\": true,\n  \"credentials\": {\n    \"client_id\": \"<string>\",\n    \"client_secret\": \"<string>\",\n    \"scopes\": \"<string>\",\n    \"webhook_secret\": \"<string>\"\n  },\n  \"integration_config\": {}\n}"

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

200

{
  "data": {
    "unique_key": "<string>",
    "display_name": "<string>",
    "provider": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "logo": "<string>",
    "forward_webhooks": true
  }
}

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

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

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

Requires an API key with the environment:integrations:update scope. Learn more about API key scopes.

Authorizations

Authorization · string · header · required

The secret key from your Nango environment.

Path Parameters

uniqueKey · string · required

The integration ID (unique_key) that you created in Nango.

Body

application/json

unique_key · string

A unique integration ID, which you will use in the other API calls to reference this integration.

display_name · string

The integration display name.

forward_webhooks · boolean

Whether to forward webhooks received for this integration.

credentials · object

Integration credentials schema for different authentication types.

Option 1

Option 2

Option 3

Show child attributes

integration_config · object

Provider-specific configuration for providers that declare an integration_config schema (e.g. private-api-generic, aws-sigv4). Only the fields you pass are updated.

Show child attributes

Response

200

application/json

Successfully updated an integration

data · object · required

Show child attributes