Skip to main content

connectIntegrationWithTokens

Connects an existing integration using a pre-issued access token and refresh token pair. No network call is made — the tokens are persisted directly on the integration (encrypted).

Use this mutation when the access + refresh tokens have already been provisioned out of band (e.g. a 3PL handed both tokens to the merchant, or the merchant generated them in the integration's dashboard) and an interactive credential exchange is unavailable or undesired.

Authentication Requirements​

  • Header Authorization must be provided
  • Header X-Company-Id must be provided

Possible Errors​

  • Integration not found in the requesting company
  • Integration of the given type does not support direct token connect
  • Either token is blank
connectIntegrationWithTokens(
  input: ConnectIntegrationWithTokensInput!
): Integration!

Arguments​

connectIntegrationWithTokens.input ● ConnectIntegrationWithTokensInput! non-null input common​

Parameters for ConnectIntegrationWithTokens

Type​

Integration object integrations​