Skip to main content
POST
Save integration

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, see Authentication for more detail.

Path Parameters

id
string
required

The id of the integration

Body

application/json
status
enum<string>

Status of the integration

Available options:
ACTIVE,
INACTIVE,
REMOVED
Example:

"ACTIVE"

apiName
enum<string>

Name of the OAuth Provider

Available options:
STRIPE,
PLAID,
UBER,
FRESHBOOKS,
SQUARE,
UPWORK,
SHOPIFY,
LONEWOLF,
GUSTO,
XERO,
UNIT,
MOOV,
QBO,
QUALPAY,
BENCH,
PARTNER_IMPLEMENTATION,
CHECK,
RUTTER,
WAVE,
ADYEN,
PAYABLI
apiAccessToken
string

Access token of the integration

customData
object | null

Custom JSON in which you can store any data with max length of 2000 characters

Example:

Response

Success

result
enum<string>

The result of the action performed.

Available options:
SUCCESS,
FAILURE
data
object

The data generated by the action performed.