Synup
Crear clave
v1Recursos/Connections/postCanjear un código de traspaso de conexión

Canjear un código de traspaso de conexión

Canjea el código de un solo uso entregado a tu successUrl. Devuelve el id de la conexión y el correo que autorizó la conexión. Canjéalo del lado del servidor en un plazo de 10 minutos; el código es de un solo uso.

post/api/v1/connections/handoff/exchange
connections:read
Cuerpo de la solicitud
codestringobligatorio
El código de un solo uso de la redirección a successUrl. De un solo uso, caduca 10 minutos después de emitirse.
Respuesta
dataobjectopcional
statusstring (connected | connected_no_listing | error)opcional
Cómo se resolvió la conexión: connected, connected_no_listing o error.
platformstring (google | facebook | apple)opcional
Qué publisher se conectó: google, facebook o apple.
connectionIdstringopcional
El id de la conexión. El mismo id que lista GET /api/v1/connections y que acepta POST /api/v1/connections/fetch-listings.
connectedAccountIdstringopcional
Idéntico a connectionId, con el nombre que esperan algunas integraciones. Ambos son el mismo valor.
boundConnectionIdstringopcional
La conexión a nivel de ubicación cuando se vinculó un listado, o null.
locationIdstringopcional
La ubicación a la que correspondía esta conexión, o null.
clientIdstringopcional
El cliente al que se limitaba esta conexión, o null.
emailstringopcional
La dirección de correo que autorizó la conexión, o null.
errorstringopcional
El código de error cuando status es error, o null.
connectedAtstringopcional
Cuándo se resolvió la conexión, como marca de tiempo ISO 8601.
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
401La clave de API falta, es inválida, expiró o fue revocada.
404El recurso no se encontró, o no pertenece a su agencia.
410El código ya se usó o ha caducado. El cuerpo de la respuesta incluye el motivo, "used" o "expired".
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
post/api/v1/connections/handoff/exchange
Su clave de API
Cuerpo de la solicitud*
{
  "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"
  }
}

Guías que usan este endpoint