Skip to main content
PATCH
/
v1
/
bridge-integrations
/
{bridgeIntegrationId}
Update a Bridge integration
curl --request PATCH \
  --url http://localhost:3001/v1/bridge-integrations/{bridgeIntegrationId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "apiKey": "<string>",
  "webhookBaseUrl": "<string>",
  "eventCategories": [],
  "pollingEnabled": true
}
'
{
  "id": "<string>",
  "organizationId": "<string>",
  "name": "<string>",
  "integrationKey": "<string>",
  "webhookId": "<string>",
  "webhookUrl": "<string>",
  "eventCategories": [],
  "hasApiKey": true,
  "lastTransferSyncedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Headers

​
authorization
string
Minimum string length: 1
​
x-organization-id
string
Minimum string length: 1

Path Parameters

​
bridgeIntegrationId
string
required
Minimum string length: 1

Body

application/json
​
name
string
Minimum string length: 1
​
apiKey
string
Minimum string length: 1
​
webhookBaseUrl
string<uri>
​
eventCategories
enum<string>[]
Minimum array length: 1
Available options:
customer,
kyc_link,
liquidation_address.drain,
static_memo.activity,
transfer,
virtual_account.activity,
bridge_wallet.activity,
card_account,
card_transaction,
card_withdrawal,
posted_card_account_transaction,
external_account
​
pollingEnabled
boolean

Response

Default Response

​
id
string
required
​
organizationId
string
required
​
name
string
required
​
integrationKey
string
required
​
webhookId
string
required
​
webhookUrl
string<uri>
required
​
webhookStatus
enum<string>
required
Available options:
disabled,
active,
deleted
​
eventCategories
enum<string>[]
required
Available options:
customer,
kyc_link,
liquidation_address.drain,
static_memo.activity,
transfer,
virtual_account.activity,
bridge_wallet.activity,
card_account,
card_transaction,
card_withdrawal,
posted_card_account_transaction,
external_account
​
hasApiKey
enum<boolean>
required
Available options:
true
​
lastTransferSyncedAt
null | string<date-time>
required
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required