Synup
Créer une clé
v1Ressources/Connexions/postÉchanger un code de relais de connexion

Échanger un code de relais de connexion

Échange le code à usage unique remis à votre successUrl. Renvoie l'id de la connexion et l'e-mail qui a autorisé la connexion. Échangez-le côté serveur dans un délai de 10 minutes ; le code est à usage unique.

post/api/v1/connections/handoff/exchange
connections:read
Corps de la requête
codestringobligatoire
Le code à usage unique issu de la redirection vers successUrl. À usage unique, il expire 10 minutes après son émission.
Réponse
dataobjectfacultatif
statusstring (connected | connected_no_listing | error)facultatif
Comment la connexion s'est conclue : connected, connected_no_listing ou error.
platformstring (google | facebook | apple)facultatif
Quel publisher a été connecté : google, facebook ou apple.
connectionIdstringfacultatif
L'id de la connexion. Le même id que celui listé par GET /api/v1/connections et accepté par POST /api/v1/connections/fetch-listings.
connectedAccountIdstringfacultatif
Identique à connectionId, sous le nom attendu par certaines intégrations. Les deux ont la même valeur.
boundConnectionIdstringfacultatif
La connexion au niveau de l'emplacement lorsqu'une fiche a été liée, ou null.
locationIdstringfacultatif
L'emplacement concerné par cette connexion, ou null.
clientIdstringfacultatif
Le client auquel cette connexion était limitée, ou null.
emailstringfacultatif
L'adresse e-mail qui a autorisé la connexion, ou null.
errorstringfacultatif
Le code d'erreur lorsque status vaut error, ou null.
connectedAtstringfacultatif
Quand la connexion s'est conclue, sous forme d'horodatage ISO 8601.
Erreurs
400Il manque un paramètre requis à la requête, ou elle est invalide.
401Clé API manquante, invalide, expirée ou révoquée.
404La ressource est introuvable, ou n'appartient pas à votre agence.
410Le code a déjà été utilisé ou a expiré. Le corps de la réponse indique la raison, "used" ou "expired".
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
post/api/v1/connections/handoff/exchange
Votre clé API
Corps de la requête*
{
  "data": {
    "status": "connected",
    "platform": "google",
    "connectionId": "conn_789",
    "connectedAccountId": "conn_789",
    "boundConnectionId": "conn_456",
    "locationId": "loc_456",
    "clientId": null,
    "email": "owner@grovestreetdental.com",
    "error": null,
    "connectedAt": "2026-09-17T10:00:00.000Z"
  }
}

Guides qui utilisent cet endpoint