Update a Connection

curl --request PATCH \
  --url https://api.example.com/v2/integrations/connections/{connection_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "provider_name": "<string>",
  "name": "<string>",
  "base_url": "<string>",
  "tenant": "<string>",
  "endpoint_name": "<string>",
  "endpoint_version": "<string>",
  "scope": "<string>",
  "client_id": "<string>",
  "client_secret": "<string>",
  "username": "<string>",
  "password": "<string>",
  "branches": [
    "<string>"
  ],
  "default_currency": "<string>"
}
'

import requests

url = "https://api.example.com/v2/integrations/connections/{connection_id}"

payload = {
    "provider_name": "<string>",
    "name": "<string>",
    "base_url": "<string>",
    "tenant": "<string>",
    "endpoint_name": "<string>",
    "endpoint_version": "<string>",
    "scope": "<string>",
    "client_id": "<string>",
    "client_secret": "<string>",
    "username": "<string>",
    "password": "<string>",
    "branches": ["<string>"],
    "default_currency": "<string>"
}
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({
    provider_name: '<string>',
    name: '<string>',
    base_url: '<string>',
    tenant: '<string>',
    endpoint_name: '<string>',
    endpoint_version: '<string>',
    scope: '<string>',
    client_id: '<string>',
    client_secret: '<string>',
    username: '<string>',
    password: '<string>',
    branches: ['<string>'],
    default_currency: '<string>'
  })
};

fetch('https://api.example.com/v2/integrations/connections/{connection_id}', 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.example.com/v2/integrations/connections/{connection_id}",
  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([
    'provider_name' => '<string>',
    'name' => '<string>',
    'base_url' => '<string>',
    'tenant' => '<string>',
    'endpoint_name' => '<string>',
    'endpoint_version' => '<string>',
    'scope' => '<string>',
    'client_id' => '<string>',
    'client_secret' => '<string>',
    'username' => '<string>',
    'password' => '<string>',
    'branches' => [
        '<string>'
    ],
    'default_currency' => '<string>'
  ]),
  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.example.com/v2/integrations/connections/{connection_id}"

	payload := strings.NewReader("{\n  \"provider_name\": \"<string>\",\n  \"name\": \"<string>\",\n  \"base_url\": \"<string>\",\n  \"tenant\": \"<string>\",\n  \"endpoint_name\": \"<string>\",\n  \"endpoint_version\": \"<string>\",\n  \"scope\": \"<string>\",\n  \"client_id\": \"<string>\",\n  \"client_secret\": \"<string>\",\n  \"username\": \"<string>\",\n  \"password\": \"<string>\",\n  \"branches\": [\n    \"<string>\"\n  ],\n  \"default_currency\": \"<string>\"\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.example.com/v2/integrations/connections/{connection_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"provider_name\": \"<string>\",\n  \"name\": \"<string>\",\n  \"base_url\": \"<string>\",\n  \"tenant\": \"<string>\",\n  \"endpoint_name\": \"<string>\",\n  \"endpoint_version\": \"<string>\",\n  \"scope\": \"<string>\",\n  \"client_id\": \"<string>\",\n  \"client_secret\": \"<string>\",\n  \"username\": \"<string>\",\n  \"password\": \"<string>\",\n  \"branches\": [\n    \"<string>\"\n  ],\n  \"default_currency\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v2/integrations/connections/{connection_id}")

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  \"provider_name\": \"<string>\",\n  \"name\": \"<string>\",\n  \"base_url\": \"<string>\",\n  \"tenant\": \"<string>\",\n  \"endpoint_name\": \"<string>\",\n  \"endpoint_version\": \"<string>\",\n  \"scope\": \"<string>\",\n  \"client_id\": \"<string>\",\n  \"client_secret\": \"<string>\",\n  \"username\": \"<string>\",\n  \"password\": \"<string>\",\n  \"branches\": [\n    \"<string>\"\n  ],\n  \"default_currency\": \"<string>\"\n}"

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

{
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "is_authentication_pending": true,
  "is_running_setup": true,
  "is_sync_disabled": true,
  "health": {
    "authentication_required": true,
    "message": "<string>",
    "healthy": true,
    "suggested_resolution": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "models": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "name": "<string>",
      "is_read_enabled": true,
      "is_write_enabled": true,
      "is_custom_object": true,
      "is_file_upload_enabled": true,
      "is_webhooks_setup": true,
      "next_sync_at": "2023-11-07T05:31:56Z",
      "connection_id": "<string>",
      "last_sync": {
        "created_at": "2023-11-07T05:31:56Z",
        "modified_at": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "attempt": 123,
        "batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "completed_at": "2023-11-07T05:31:56Z",
        "entity_id": "<string>",
        "error": "<string>",
        "file_id": "<string>",
        "is_initial_sync": true,
        "is_one_off": true,
        "model_id": "<string>",
        "pagination_state": {},
        "started_at": "2023-11-07T05:31:56Z",
        "timerange_end": "2023-11-07T05:31:56Z",
        "timerange_start": "2023-11-07T05:31:56Z",
        "object": "<string>"
      },
      "object": "<string>",
      "display_name": "<string>",
      "is_read_supported": true,
      "is_write_supported": true,
      "is_sync_supported": true
    }
  ],
  "next_sync_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "owner_id": "<string>",
  "requires_setup": true,
  "provider_name": "<string>",
  "base_url": "<string>",
  "tenant": "<string>",
  "endpoint_name": "<string>",
  "endpoint_version": "<string>",
  "scope": "<string>",
  "branches": [
    "<string>"
  ],
  "default_currency": "<string>",
  "object": "<string>",
  "authorization_url": "<string>",
  "provider": {
    "categories": [],
    "display_name": "<string>",
    "is_api_connection": true,
    "is_webhooks_supported": true,
    "cash_app_features": {
      "can_unpost_payment": false,
      "can_post_on_account_payment": false
    },
    "color": "<string>",
    "connection_guide_url": "<string>",
    "connection_instructions": [
      "<string>"
    ],
    "documentation_url": "<string>",
    "description": "<string>",
    "is_enabled": true,
    "is_manual_sync_supported": true,
    "logo": "<string>",
    "logo_square": "<string>",
    "required_settings": [
      "<string>"
    ],
    "short_description": "<string>",
    "website": "<string>"
  },
  "is_configured": true,
  "missing_settings": [
    "<string>"
  ],
  "is_healthy": true,
  "linked_integration_id": "<string>"
}

{
  "type": "<string>",
  "status": 123,
  "title": "<string>",
  "errors": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ],
  "detail": "<string>"
}

PATCH

integrations

connections

{connection_id}

Update a Connection

curl --request PATCH \
  --url https://api.example.com/v2/integrations/connections/{connection_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "provider_name": "<string>",
  "name": "<string>",
  "base_url": "<string>",
  "tenant": "<string>",
  "endpoint_name": "<string>",
  "endpoint_version": "<string>",
  "scope": "<string>",
  "client_id": "<string>",
  "client_secret": "<string>",
  "username": "<string>",
  "password": "<string>",
  "branches": [
    "<string>"
  ],
  "default_currency": "<string>"
}
'

import requests

url = "https://api.example.com/v2/integrations/connections/{connection_id}"

payload = {
    "provider_name": "<string>",
    "name": "<string>",
    "base_url": "<string>",
    "tenant": "<string>",
    "endpoint_name": "<string>",
    "endpoint_version": "<string>",
    "scope": "<string>",
    "client_id": "<string>",
    "client_secret": "<string>",
    "username": "<string>",
    "password": "<string>",
    "branches": ["<string>"],
    "default_currency": "<string>"
}
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({
    provider_name: '<string>',
    name: '<string>',
    base_url: '<string>',
    tenant: '<string>',
    endpoint_name: '<string>',
    endpoint_version: '<string>',
    scope: '<string>',
    client_id: '<string>',
    client_secret: '<string>',
    username: '<string>',
    password: '<string>',
    branches: ['<string>'],
    default_currency: '<string>'
  })
};

fetch('https://api.example.com/v2/integrations/connections/{connection_id}', 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.example.com/v2/integrations/connections/{connection_id}",
  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([
    'provider_name' => '<string>',
    'name' => '<string>',
    'base_url' => '<string>',
    'tenant' => '<string>',
    'endpoint_name' => '<string>',
    'endpoint_version' => '<string>',
    'scope' => '<string>',
    'client_id' => '<string>',
    'client_secret' => '<string>',
    'username' => '<string>',
    'password' => '<string>',
    'branches' => [
        '<string>'
    ],
    'default_currency' => '<string>'
  ]),
  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.example.com/v2/integrations/connections/{connection_id}"

	payload := strings.NewReader("{\n  \"provider_name\": \"<string>\",\n  \"name\": \"<string>\",\n  \"base_url\": \"<string>\",\n  \"tenant\": \"<string>\",\n  \"endpoint_name\": \"<string>\",\n  \"endpoint_version\": \"<string>\",\n  \"scope\": \"<string>\",\n  \"client_id\": \"<string>\",\n  \"client_secret\": \"<string>\",\n  \"username\": \"<string>\",\n  \"password\": \"<string>\",\n  \"branches\": [\n    \"<string>\"\n  ],\n  \"default_currency\": \"<string>\"\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.example.com/v2/integrations/connections/{connection_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"provider_name\": \"<string>\",\n  \"name\": \"<string>\",\n  \"base_url\": \"<string>\",\n  \"tenant\": \"<string>\",\n  \"endpoint_name\": \"<string>\",\n  \"endpoint_version\": \"<string>\",\n  \"scope\": \"<string>\",\n  \"client_id\": \"<string>\",\n  \"client_secret\": \"<string>\",\n  \"username\": \"<string>\",\n  \"password\": \"<string>\",\n  \"branches\": [\n    \"<string>\"\n  ],\n  \"default_currency\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v2/integrations/connections/{connection_id}")

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  \"provider_name\": \"<string>\",\n  \"name\": \"<string>\",\n  \"base_url\": \"<string>\",\n  \"tenant\": \"<string>\",\n  \"endpoint_name\": \"<string>\",\n  \"endpoint_version\": \"<string>\",\n  \"scope\": \"<string>\",\n  \"client_id\": \"<string>\",\n  \"client_secret\": \"<string>\",\n  \"username\": \"<string>\",\n  \"password\": \"<string>\",\n  \"branches\": [\n    \"<string>\"\n  ],\n  \"default_currency\": \"<string>\"\n}"

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

{
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "is_authentication_pending": true,
  "is_running_setup": true,
  "is_sync_disabled": true,
  "health": {
    "authentication_required": true,
    "message": "<string>",
    "healthy": true,
    "suggested_resolution": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "models": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "name": "<string>",
      "is_read_enabled": true,
      "is_write_enabled": true,
      "is_custom_object": true,
      "is_file_upload_enabled": true,
      "is_webhooks_setup": true,
      "next_sync_at": "2023-11-07T05:31:56Z",
      "connection_id": "<string>",
      "last_sync": {
        "created_at": "2023-11-07T05:31:56Z",
        "modified_at": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "attempt": 123,
        "batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "completed_at": "2023-11-07T05:31:56Z",
        "entity_id": "<string>",
        "error": "<string>",
        "file_id": "<string>",
        "is_initial_sync": true,
        "is_one_off": true,
        "model_id": "<string>",
        "pagination_state": {},
        "started_at": "2023-11-07T05:31:56Z",
        "timerange_end": "2023-11-07T05:31:56Z",
        "timerange_start": "2023-11-07T05:31:56Z",
        "object": "<string>"
      },
      "object": "<string>",
      "display_name": "<string>",
      "is_read_supported": true,
      "is_write_supported": true,
      "is_sync_supported": true
    }
  ],
  "next_sync_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "owner_id": "<string>",
  "requires_setup": true,
  "provider_name": "<string>",
  "base_url": "<string>",
  "tenant": "<string>",
  "endpoint_name": "<string>",
  "endpoint_version": "<string>",
  "scope": "<string>",
  "branches": [
    "<string>"
  ],
  "default_currency": "<string>",
  "object": "<string>",
  "authorization_url": "<string>",
  "provider": {
    "categories": [],
    "display_name": "<string>",
    "is_api_connection": true,
    "is_webhooks_supported": true,
    "cash_app_features": {
      "can_unpost_payment": false,
      "can_post_on_account_payment": false
    },
    "color": "<string>",
    "connection_guide_url": "<string>",
    "connection_instructions": [
      "<string>"
    ],
    "documentation_url": "<string>",
    "description": "<string>",
    "is_enabled": true,
    "is_manual_sync_supported": true,
    "logo": "<string>",
    "logo_square": "<string>",
    "required_settings": [
      "<string>"
    ],
    "short_description": "<string>",
    "website": "<string>"
  },
  "is_configured": true,
  "missing_settings": [
    "<string>"
  ],
  "is_healthy": true,
  "linked_integration_id": "<string>"
}

{
  "type": "<string>",
  "status": 123,
  "title": "<string>",
  "errors": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ],
  "detail": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

connection_id

string

required

Body

application/json

Update schema for Acumatica ERP connections.

provider_name

string

required

Allowed value: "acumatica"

name

string | null

User defined name of the linked integration.

base_url

string | null

Acumatica instance base URL including the IIS instance segment (e.g. https://erpsandbox.example.com/AcumaticaSandbox).

tenant

string | null

Acumatica tenant (company) login name as it appears on the Tenants form (SM203520). For multi-company installs this is also the suffix appended to client_id after @.

endpoint_name

string | null

Web service endpoint name (default 'Default'; custom endpoints supported).

endpoint_version

string | null

Endpoint version string (e.g. '24.200.001'). Mirrors Acumatica release.

scope

string | null

OAuth scope string. 'api' for single-session, 'api offline_access' to get a refresh token, 'api:concurrent_access' to allow multiple simultaneous tokens for the same client.

client_id

string<password> | null

OAuth client ID from the Connected Application (includes '@TenantName' suffix).

client_secret

string<password> | null

OAuth shared secret. Encrypted at rest via AWS KMS.

username

string<password> | null

Acumatica API user (resource-owner credentials).

password

string<password> | null

Acumatica API user password. Encrypted at rest via AWS KMS.

branches

string[] | null

Branches the connection is authorized to sync. Each value is a BranchCD code (e.g. 'STSMC') that is sent in the PX-CbApiBranch header on AR transactional reads.

default_currency

string | null

ISO-4217 currency code used as the fallback when Acumatica's Default endpoint omits CurrencyID on AR documents — Invoice and CreditMemo entities do not expose a currency field in the current contract, so per-tenant single-currency installs need to set this on the connection. Payment rows carry CurrencyID directly and ignore this. Mapper fails loudly if neither the row nor this column carries a currency.

Response

Successful Response

Acumatica ERP integration connection.

created_at

string<date-time>

required

modified_at

string<date-time> | null

required

string

required

is_authentication_pending

boolean

required

Whether this connection is still pending authentication. This is normally only used for oauth2 connections.

is_running_setup

boolean

required

is_sync_disabled

boolean

required

Whether sync tasks are disabled. The intent of this column is to temporarily pause sync tasks for maintenance/deploys/etc.

health

IntegrationConnectionHealth · object | null

required

Show child attributes

models

IntegrationConnectionModel · object[]

required

List of unified models synced through this connection

Show child attributes

next_sync_at

string<date-time> | null

required

When the next sync is scheduled to run.

name

string | null

required

User defined name of the linked integration.

owner_id

string | null

required

requires_setup

boolean

required

provider_name

string

required

Allowed value: "acumatica"

base_url

string

required

Acumatica instance base URL including the IIS instance segment (e.g. https://erpsandbox.example.com/AcumaticaSandbox).

tenant

string

required

Acumatica tenant (company) login name as it appears on the Tenants form (SM203520). For multi-company installs this is also the suffix appended to client_id after @.

endpoint_name

string

required

Web service endpoint name (default 'Default'; custom endpoints supported).

endpoint_version

string

required

Endpoint version string (e.g. '24.200.001'). Mirrors Acumatica release.

scope

string | null

required

OAuth scope string. 'api' for single-session, 'api offline_access' to get a refresh token, 'api:concurrent_access' to allow multiple simultaneous tokens for the same client.

branches

string[] | null

required

Branches the connection is authorized to sync. Each value is a BranchCD code (e.g. 'STSMC') that is sent in the PX-CbApiBranch header on AR transactional reads.

default_currency

string | null

required

object

string

required

read-only

String representing the object's type. Objects of the same type share the same value.

authorization_url

string | null

required

The authorization url for this connection.

provider

object

required

read-only

The integration provider for this connection.

Show child attributes

is_configured

boolean

required

read-only

Whether the integration connection is configured.

missing_settings

string[]

required

read-only

List of missing settings.

is_healthy

boolean

required

read-only

Whether the integration connection is healthy. This is determined based on a few checks:

Configuration (e.g. settings)
Connection
Permissions

linked_integration_id

string | null

required

The v1 linked integration id.

Delete a Connection Authenticate a Connection

⌘I