v1Resources/Connections/postCreate a connect link
Create a connect link
Creates a single-use link that connects a client's brand-level account on Facebook, Instagram, LinkedIn, X, Pinterest or YouTube. Send the url to someone who can access the client in Synup: they open it while signed in and approve the connection in their own browser. The link works once and expires after an hour if no one opens it. This endpoint never completes the connection itself; check the link's status to see when it finishes. YouTube must be enabled for the workspace (403 otherwise).
post
connections:write/api/v1/connections/connect-linksRequest body
clientIdstringrequired
The client whose account to connect.
platformstring (facebook | instagram | linkedin | x | pinterest | youtube)required
The network to connect: facebook, instagram, linkedin, x, pinterest or youtube.
reconnectConnectionIdstringoptional
An existing connection of this client to reconnect instead of adding a new one. Facebook and YouTube only.
Response
dataobjectoptional
idstringoptional
The link's id. Use it to check the status or cancel the link.
platformstringoptional
The network the link connects.
clientIdstringoptional
The client the link is for.
statusstring (pending | started | completed | abandoned | cancelled | expired)optional
Where the link stands: pending (not opened yet), started (opened, waiting for the person to finish), completed (the account is connected), abandoned (opened but not finished within an hour), cancelled, or expired (not opened before expiresAt).
expiresAtstringoptional
When the link stops working if no one has opened it.
startedAtstringoptional
When the link was opened, or null if it hasn't been.
connectionIdstringoptional
The connection the link produced, once completed. Null until then.
reconnectConnectionIdstringoptional
The connection being reconnected, when the link was created to reconnect one. Only the create response returns it; status lookups return null.
urlstringoptional
The link to send. It opens in a browser, carries no credentials and works once.
Errors
400The request is missing a required parameter or is otherwise malformed.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
429Too many requests. Retry after the number of seconds in the Retry-After header.
post/api/v1/connections/connect-links
Your API key
Request body*
{}Guides that use this resource
- What Is a Business Listings API?A business listings API manages a business's name, address, hours and more across many publishers at once, with sync status and duplicate detection built in.
- Business Listings API: Complete Developer GuideHow a business listings API works and how to create, update, sync and monitor locations across Google, Apple, Bing and directories with the Synup API.
- Google Business Profile API vs a Listings Management APIHow Google's Business Profile API compares with a listings management API on scope, access, sync status, duplicates and reviews, and when to use each.
- How to Add Local Marketing Features to Your SaaSAdd listings management, reviews, Google posts, profile analytics, rank tracking and AI visibility to a SaaS product with the Synup API, tenant by tenant.
- How to Update Business Information Across Google, Apple, Bing and DirectoriesPush one business-information change to Google, Apple, Bing and the directory network through a single API call, and verify it reached each publisher.
- How to Manage Thousands of Business Locations via APIDesign a sync job for thousands of locations on the Synup API with cursor pagination, tags, rate-limit handling, an id map and rollup health checks.
- How Google Business Profile Synchronization WorksGoogle Business Profile sync rests on an owner's OAuth consent, matching a location to the right Google listing, then a write-and-verify loop.
- How to Build a Multi-Location Marketing DashboardBuild a multi-location marketing dashboard from the API's rollup endpoints, one call per panel, covering listings, reviews, rank, AI visibility and duplicates.
- How to Connect and Manage Google Business Profiles via APIConnect a Google Business Profile to a location, match the account's listings, keep the profile in sync and handle reconnects with the Synup API.
- Building Publisher Integrations Directly vs Using SynupWhat it really costs to integrate Google, Apple, Bing and directories yourself, versus one API, and how to decide between them or combine both.