Skip to main content
PATCH
/
integrations
/
{connector_type}
Update editable fields on a connector
curl --request PATCH \
  --url https://api.arcuserp.com/v1/integrations/{connector_type} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "display_name": "<string>",
  "mode": "sandbox",
  "is_active": true,
  "config": {},
  "ship_from_name": "<string>",
  "ship_from_address1": "<string>",
  "ship_from_city": "<string>",
  "ship_from_state": "<string>",
  "ship_from_zip": "<string>",
  "seller_id": "<string>",
  "bank_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "connector_type": "stripe",
    "display_name": "<string>",
    "mode": "sandbox",
    "is_active": true,
    "config": {},
    "has_webhook_secret": true,
    "has_credentials_secret_arn": true,
    "last_sync_at": "2023-11-07T05:31:56Z",
    "sync_status": "<string>",
    "sync_error": "<string>",
    "ship_from_name": "<string>",
    "ship_from_address1": "<string>",
    "ship_from_city": "<string>",
    "ship_from_state": "<string>",
    "ship_from_zip": "<string>",
    "seller_id": "<string>",
    "bank_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.arcuserp.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.

Path Parameters

​
connector_type
enum<string>
required

Connector type. Enum: stripe, avatax, shippo, printnode, postmark, shopify, mapquest, google, openai, plaid, ups, fedex, usps, amazon, ebay, wwex

Available options:
stripe,
avatax,
shippo,
printnode,
postmark,
shopify,
mapquest,
google,
openai,
plaid,
ups,
fedex,
usps,
amazon,
ebay,
wwex

Body

application/json

Allowed fields: display_name, mode, is_active, config, ship_from_name, ship_from_address1, ship_from_city, ship_from_state, ship_from_zip, seller_id, bank_account_id. All other fields return 400 validation_failed. Credentials and accounting-override JSONB fields are NOT patchable here.

​
display_name
string
​
mode
enum<string>
Available options:
sandbox,
live
​
is_active
boolean
​
config
object

Provider-specific config overrides (merged)

​
ship_from_name
string
​
ship_from_address1
string
​
ship_from_city
string
​
ship_from_state
string
​
ship_from_zip
string
​
seller_id
string
​
bank_account_id
string<uuid>

Response

Updated connector row

​
data
object

A configured connector row from entity_connectors. SECURITY: credentials, webhook_secret, and credentials_secret_arn RAW VALUES are NEVER returned. has_credentials_secret_arn (boolean) indicates if credentials are stored. credentials_masked returns key names only (no values). These invariants are enforced by the canonical listConnectors/getConnectorByType handler projection and cannot be overridden by callers.