Skip to main content
POST
Regenerate onboarding URL for a connection

Authorizations

Authorization
string
header
required

Use your app's API_KEY as the username, and leave the password blank

Path Parameters

connection_id
string<uuid>
required

ID of the connection

Body

application/json
redirect_url
string<uri>

The URL to redirect the user to after they complete (or cancel) the QuickBooks setup process. This URL should be able to handle the query parameters:

  • ?state=connected if they completed the process,
  • ?state=cancelled if they cancelled it or
  • ?state=expired if they visit the onboarding link after it has expired
Example:

"https://myapp.com/quickbooks-setup-callback"

Response

Onboarding URL regenerated successfully. The full connection object is returned, with updated links.onboarding URL.

data
object