Connected Accounts

Connect Google Profile to Account

This API initiates the process of connecting a new Google My Business (GMB) account to the system. The response provides a URL for the user to complete Google's OAuth authentication flow.

Important Notes:

The response includes a URL that the user must visit to authenticate and connect their GMB account.
The provided URL is valid for 24 hours.
When the user accesses the URL, they are redirected to Google’s OAuth authentication flow.
During OAuth, the user must:
- Review and accept Google’s terms and conditions.
- Grant necessary permissions for integration.
After OAuth authentication:
- If successful, the user is redirected to the successUrl provided in the request.
- If permissions are declined or the process fails, the user is redirected to the errorUrl.

post/connected-accounts/connect-google

Request

Base URL
https://api.synup.com/api/v4
Auth
none required
TypeScript
https://skmtc.dev/synup/apis/synup-api/docs/connected-accounts/connect-google/post.ts
A function with typed inputs. Its response is checked against the schema.

Headers

Authorizationstring required

API key for authentication

Content-Typestring required

Request body

Example request

{
  "input": {
    "errorUrl": "http://www.errorurl.com",
    "successUrl": "http://www.successurl.com"
  }
}

Response

Successfully generated connection URL

Example response

{
  "data": {
    "bulkConnectLinkForGoogle": {
      "url": "http://synup.com/locations/redirect_oauth_bulk/google?token=9009dc92-2b18-421f-b856-d157f3f06d6b"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.