Skip to main content
POST
/
connections
/
{connection_id}
/
onboarding_url
Regenerate onboarding URL for a connection
curl --request POST \
  --url https://qubesync.com/api/v1/connections/{connection_id}/onboarding_url \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "redirect_url": "https://myapp.com/quickbooks-setup-callback"
}
'
{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "app_id": "550e8400-e29b-41d4-a716-446655440000",
    "username": "550e8400-e29b-41d4-a716-446655440001",
    "last_connected_at": "2023-01-01T12:00:00Z",
    "name": "My Customer Inc.",
    "company_file": "My Company File.QBW",
    "qbxml_version": "14.0",
    "quickbooks_product_name": "QuickBooks Pro 2021",
    "type": "standard",
    "redirect_url": "https://myapp.com/quickbooks-setup-callback",
    "links": {
      "self": "/api/v1/connections/123e4567-e89b-12d3-a456-426614174000",
      "ui": "/app/connections/123e4567-e89b-12d3-a456-426614174000",
      "onboarding": "https://qubesync.com/onboarding/123e4567-e89b-12d3-a456-426614174000"
    }
  }
}

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