v1Recursos/Connections/postTrocar um código de repasse de conexão
Trocar um código de repasse de conexão
Troca o código de uso único entregue à sua successUrl. Retorna o id da conexão e o e-mail que autorizou a conexão. Troque-o no servidor em até 10 minutos; o código é de uso único.
post
connections:read/api/v1/connections/handoff/exchangeCorpo da solicitação
codestringobrigatório
O código de uso único do redirecionamento para successUrl. De uso único, expira 10 minutos após ser emitido.
Resposta
dataobjectopcional
statusstring (connected | connected_no_listing | error)opcional
Como a conexão foi concluída: connected, connected_no_listing ou error.
platformstring (google | facebook | apple)opcional
Qual publisher foi conectado: google, facebook ou apple.
connectionIdstringopcional
O id da conexão. O mesmo id que GET /api/v1/connections lista e que POST /api/v1/connections/fetch-listings aceita.
connectedAccountIdstringopcional
Idêntico a connectionId, com o nome que algumas integrações esperam. Os dois são o mesmo valor.
boundConnectionIdstringopcional
A conexão em nível de local quando uma listagem foi vinculada, ou null.
locationIdstringopcional
O local ao qual esta conexão se referia, ou null.
clientIdstringopcional
O cliente ao qual esta conexão era limitada, ou null.
emailstringopcional
O endereço de e-mail que autorizou a conexão, ou null.
errorstringopcional
O código de erro quando status é error, ou null.
connectedAtstringopcional
Quando a conexão foi concluída, como carimbo de data/hora ISO 8601.
Erros
400Falta um parâmetro obrigatório na solicitação, ou ela é inválida de outra forma.
401Chave de API ausente, inválida, expirada ou revogada.
404O recurso não foi encontrado, ou não pertence à sua agência.
410O código já foi usado ou expirou. O corpo da resposta traz o motivo, "used" ou "expired".
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
post/api/v1/connections/handoff/exchange
Sua chave de API
Corpo da solicitação*
{
"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"
}
}