v1Ressources/Connexions/postCréer un lien de connexion
Créer un lien de connexion
Crée un lien à usage unique qui connecte un compte de marque d'un client sur Facebook, Instagram, LinkedIn, X, Pinterest ou YouTube. Envoyez l'url à une personne ayant accès au client dans Synup : elle l'ouvre en étant connectée et approuve la connexion dans son propre navigateur. Le lien fonctionne une fois et expire au bout d'une heure si personne ne l'ouvre. Ce endpoint ne finalise jamais la connexion lui-même ; consultez le statut du lien pour savoir quand elle aboutit. YouTube doit être activé pour l'espace de travail (403 sinon).
post
connections:write/api/v1/connections/connect-linksCorps de la requête
clientIdstringobligatoire
Le client dont le compte doit être connecté.
platformstring (facebook | instagram | linkedin | x | pinterest | youtube)obligatoire
Le réseau à connecter : facebook, instagram, linkedin, x, pinterest ou youtube.
reconnectConnectionIdstringfacultatif
Une connexion existante de ce client à reconnecter au lieu d'en ajouter une nouvelle. Facebook et YouTube uniquement.
Réponse
dataobjectfacultatif
idstringfacultatif
L'id du lien. Utilisez-le pour consulter le statut ou annuler le lien.
platformstringfacultatif
Le réseau que le lien connecte.
clientIdstringfacultatif
Le client auquel le lien est destiné.
statusstring (pending | started | completed | abandoned | cancelled | expired)facultatif
Où en est le lien : pending (pas encore ouvert), started (ouvert, en attente que la personne termine), completed (le compte est connecté), abandoned (ouvert mais non terminé dans l'heure), cancelled, ou expired (non ouvert avant expiresAt).
expiresAtstringfacultatif
Quand le lien cesse de fonctionner si personne ne l'a ouvert.
startedAtstringfacultatif
Quand le lien a été ouvert, ou null s'il ne l'a pas été.
connectionIdstringfacultatif
La connexion créée par le lien, une fois terminé. Null jusque-là.
reconnectConnectionIdstringfacultatif
La connexion reconnectée, lorsque le lien a été créé pour en reconnecter une. Seule la réponse de création la renvoie ; les consultations de statut renvoient null.
urlstringfacultatif
Le lien à envoyer. Il s'ouvre dans un navigateur, ne contient aucun identifiant et fonctionne une fois.
Erreurs
400Il manque un paramètre requis à la requête, ou elle est invalide.
401Clé API manquante, invalide, expirée ou révoquée.
403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.
404La ressource est introuvable, ou n'appartient pas à votre agence.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
post/api/v1/connections/connect-links
Votre clé API
Corps de la requête*
{}Guides qui utilisent cette ressource
- 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.