Sign in

v1

latestOpenAPI 3.0.12026-07-26222700728.0 KB
Integration Management

Save integration

Save (or update an existing) integration

post/v6/integrations/{id}

Path parameters

idstring required

The id of the integration

Request body

status'ACTIVE' | 'INACTIVE' | 'REMOVED'

Status of the integration

apiName'BOX' | 'CLOVER' | 'STRIPE' | 'PLAID' | 'KNOX' | 'UBER' | 'FRESHBOOKS' | 'HARVEST' | 'KW' | 'FRESHBOOKS2' | 'CAPITAL_ONE' | 'SQUARE' | 'DOTLOOP' | 'REALOGY' | 'UPWORK' | 'SHOPIFY' | 'DEDUCTR' | 'ENTERPRISE' | 'MOXIWORKS' | 'APPDIRECT' | 'LONEWOLF' | 'LONEWOLF_TRANSACTIONDESK' | 'SAMPLE_BANK' | 'TAXBOT' | 'GUSTO' | 'XERO' | 'UNIT' | 'MOOV' | 'QBO' | 'QUALPAY' | 'BENCH' | 'PARTNER_IMPLEMENTATION' | 'CHECK' | 'RUTTER' | 'WAVE' | 'MANUAL_ENTRY' | 'CSV_IMPORT' | 'ADYEN' | 'PAYABLI'

Name of the OAuth Provider

apiAccessTokenstring

Access token of the integration

Example request

{
  "status": "ACTIVE",
  "customData": {
    "internal_key": "some_internal_key",
    "some_other_field": 23434
  }
}

Response

Success

result'SUCCESS' | 'FAILURE'

The result of the action performed.

Example response

{
  "data": {
    "id": "int_12345",
    "status": "ACTIVE",
    "apiName": "PLAID",
    "iconUrl": "https://cdn.sandbox.tight.com/icons/banks/56.png"
  }
}