v1Recursos/Connections/postCriar um link de conexão
Criar um link de conexão
Cria um link de uso único que conecta uma conta de marca de um cliente no Facebook, Instagram, LinkedIn, X, Pinterest ou YouTube. Envie a url para alguém com acesso ao cliente na Synup: a pessoa abre o link com a sessão iniciada e aprova a conexão no próprio navegador. O link funciona uma vez e expira após uma hora se ninguém o abrir. Este endpoint nunca conclui a conexão por conta própria; consulte o status do link para saber quando ela termina. O YouTube precisa estar ativado para o workspace (caso contrário, 403).
post
connections:write/api/v1/connections/connect-linksCorpo da solicitação
clientIdstringobrigatório
O cliente cuja conta será conectada.
platformstring (facebook | instagram | linkedin | x | pinterest | youtube)obrigatório
A rede a conectar: facebook, instagram, linkedin, x, pinterest ou youtube.
reconnectConnectionIdstringopcional
Uma conexão existente deste cliente para reconectar em vez de adicionar uma nova. Apenas Facebook e YouTube.
Resposta
dataobjectopcional
idstringopcional
O id do link. Use-o para consultar o status ou cancelar o link.
platformstringopcional
A rede que o link conecta.
clientIdstringopcional
O cliente a que o link se destina.
statusstring (pending | started | completed | abandoned | cancelled | expired)opcional
Em que ponto está o link: pending (ainda não aberto), started (aberto, aguardando a pessoa terminar), completed (a conta está conectada), abandoned (aberto, mas não concluído em uma hora), cancelled ou expired (não aberto antes de expiresAt).
expiresAtstringopcional
Quando o link deixa de funcionar se ninguém o abriu.
startedAtstringopcional
Quando o link foi aberto, ou null se ainda não foi.
connectionIdstringopcional
A conexão gerada pelo link, depois de concluído. Null até lá.
reconnectConnectionIdstringopcional
A conexão sendo reconectada, quando o link foi criado para reconectar uma. Somente a resposta de criação a retorna; as consultas de status retornam null.
urlstringopcional
O link a enviar. Ele abre no navegador, não contém credenciais e funciona uma vez.
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.
403A chave não tem a permissão exigida, ou não está autorizada para este cliente/local.
404O recurso não foi encontrado, ou não pertence à sua agência.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
post/api/v1/connections/connect-links
Sua chave de API
Corpo da solicitação*
{}Guias que usam este recurso
- 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.