Connections
Gerencie as contas de publisher e redes sociais conectadas da sua agência, suas contas de anúncios, predefinições de configuração de boost e apps de negócio conectados.
Retorna as contas de publisher/redes sociais conectadas da sua agência (Google, Facebook, Instagram, LinkedIn, TikTok e outras), opcionalmente filtradas por cliente ou plataforma.
Listar contas conectadas
/api/v1/connections{
"data": {
"accounts": [
{
"id": "conn_1",
"platform": "google",
"displayName": "Acme Dental — Google",
"providerAccountId": "112233445566",
"credentialsValid": true,
"fetchStatus": "ok",
"fetchError": null,
"errorTag": null,
"gmbGroupIds": [],
"expiresAt": null,
"dataAccessExpiresAt": "2026-05-01T00:00:00.000Z",
"channel": "local",
"clientId": "cli_123",
"synupLocationId": null,
"clientLocationId": "loc_456"
}
],
"nextCursor": null,
"totalCount": 1
}
}Quantos locais deste cliente (ou de toda a agência) têm Google/Facebook conectado ou não. Limite o escopo com tags.
Obter um resumo de contas conectadas
/api/v1/connections/summary{
"data": {
"total": 5,
"google": {
"connected": 3,
"notConnected": 2
},
"facebook": {
"connected": 1,
"notConnected": 4
}
}
}Retorna uma URL de autorização OAuth do Google para abrir em um navegador e conectar o Perfil da Empresa no Google deste local. Este endpoint não pode concluir a conexão sozinho — a tela de consentimento do Google requer um humano interativo.
Obter uma URL de conexão do Google
/api/v1/connections/google/connect-url{
"data": {
"provider": "google",
"locationId": "loc_456",
"url": "https://accounts.google.com/o/oauth2/v2/auth?client_id=...&redirect_uri=...&response_type=code&scope=...&state=...",
"note": "Open this URL in a browser under the account owner's control. There is no callback to your integration — once approved, poll GET /api/v1/connections to see the new connection."
}
}Retorna uma URL de autorização OAuth do Facebook para abrir em um navegador e conectar a Página do Facebook deste local. Este endpoint não pode concluir a conexão sozinho — a tela de consentimento do Facebook requer um humano interativo.
Obter uma URL de conexão do Facebook
/api/v1/connections/facebook/connect-url{
"data": {
"provider": "facebook",
"locationId": "loc_456",
"url": "https://www.facebook.com/v19.0/dialog/oauth?client_id=...&redirect_uri=...&scope=...&state=...&response_type=code",
"note": "Open this URL in a browser under the account owner's control. There is no callback to your integration — once approved, poll GET /api/v1/connections to see the new connection."
}
}Retorna as contas de anúncios de mídia paga disponíveis em uma conta conectada (Facebook, Instagram, LinkedIn ou TikTok).
Listar contas de anúncios
/api/v1/connections/ad-accounts{
"data": {
"adAccounts": [
{
"id": "adacct_1",
"connectionId": "conn_1",
"platformAccountId": "act_549988676430053",
"name": "Acme Dental Ads",
"platform": "facebook",
"status": "active",
"isSelected": true,
"currency": "USD",
"archived": false,
"createdAt": "2026-01-15T10:00:00.000Z",
"updatedAt": "2026-01-15T10:00:00.000Z"
}
]
}
}Força uma nova busca imediata das contas de anúncios de uma conta conectada a partir da plataforma, em vez de esperar pela sincronização diária em segundo plano. Retorna a lista atualizada.
Sincronizar contas de anúncios
/api/v1/connections/ad-accounts/sync{
"data": {
"adAccounts": [
{
"id": "adacct_1",
"connectionId": "conn_1",
"platformAccountId": "act_549988676430053",
"name": "Acme Dental Ads",
"platform": "facebook",
"status": "active",
"isSelected": false,
"currency": "USD",
"archived": false,
"createdAt": "2026-01-15T10:00:00.000Z",
"updatedAt": "2026-02-01T09:00:00.000Z"
}
]
}
}Escolhe qual das contas de anúncios de uma conta conectada é usada ao impulsionar publicações. Apenas uma conta de anúncios pode ser selecionada por conta conectada por vez.
Selecionar uma conta de anúncios
/api/v1/connections/ad-accounts/select{
"data": {
"selected": true
}
}Vincula uma listagem já obtida de uma conta já conectada a um local que ainda não tem conexão própria. Não é uma nova concessão OAuth — caId já deve ser uma conta conectada; isso apenas reaproveita esse login. Somente Google e Facebook.
Atribuir uma listagem a um local
/api/v1/connections/locations/assign{
"data": {
"id": "listing_1",
"platform": "google",
"synupLocationId": null,
"clientLocationId": "loc_456",
"platformResourceName": "accounts/123/locations/456",
"platformPageName": "Acme Dental — Downtown"
}
}Confirma uma sugestão da pontuação NAP, criando uma conexão em nível de local a partir de uma listagem obtida já correspondida a um local do Synup. Falha se a listagem não tiver local correspondido (400), já estiver conectada (409), ou o local já tiver uma conexão nessa plataforma (409).
Confirmar uma correspondência sugerida
/api/v1/connections/locations/confirm-match{
"data": {
"id": "listing_1",
"platform": "google",
"synupLocationId": null,
"clientLocationId": "loc_456",
"platformResourceName": "accounts/123/locations/456",
"platformPageName": "Acme Dental — Downtown"
}
}Executa novamente a pontuação NAP (nome/endereço/telefone) sobre as listagens já obtidas de uma conta conectada. Não busca novamente na plataforma — use POST /api/v1/connections/fetch-listings para isso. Limitado a uma vez a cada 24 horas por conta; uma chamada dentro dessa janela retorna 429 com um timestamp retryAt.
Solicitar novas sugestões de correspondência
/api/v1/connections/request-matches{
"data": {
"scored": 4,
"message": null
}
}Força uma nova busca imediata das listagens de uma conta conectada diretamente na plataforma — não apenas uma nova pontuação do que já está armazenado, que é POST /api/v1/connections/request-matches. Executa de forma síncrona; a resposta confirma que a busca já foi concluída.
Forçar nova busca das listagens de uma conta
/api/v1/connections/fetch-listings{
"data": {
"status": "completed",
"count": 4
}
}Retorna as configurações de boost salvas (predefinições reutilizáveis de segmentação e orçamento para impulsionar uma publicação) em uma conta conectada.
Listar configurações de boost
/api/v1/connections/boost-configs{
"data": {
"boostConfigs": [
{
"id": "boost_1",
"connectionId": "conn_1",
"adAccountId": "adacct_1",
"name": "Local awareness — $10/day",
"platform": "facebook",
"targeting": {
"ageMin": 25,
"ageMax": 55,
"genders": [],
"geoLocations": {
"countries": [],
"regions": [],
"cities": [],
"zips": []
},
"interests": [],
"publisherPlatforms": [
"facebook"
]
},
"dailyBudget": 10,
"durationDays": 7,
"delayHours": 0,
"publisherPlatforms": [
"facebook"
],
"archived": false,
"createdAt": "2026-01-15T10:00:00.000Z",
"updatedAt": "2026-01-15T10:00:00.000Z"
}
]
}
}Salva uma nova configuração de boost reutilizável (segmentação, orçamento diário e duração) na conta de anúncios de uma conta conectada. Isso apenas armazena uma predefinição para uso posterior — não impulsiona uma publicação, não envia nada à plataforma de anúncios, e não gasta dinheiro algum. Dinheiro só é gasto quando esta configuração salva é posteriormente aplicada para impulsionar uma publicação específica.
Criar uma configuração de boost
/api/v1/connections/boost-configs{
"data": {
"boostConfig": {
"id": "boost_1",
"connectionId": "conn_1",
"adAccountId": "adacct_1",
"name": "Local awareness — $10/day",
"platform": "facebook",
"targeting": {
"ageMin": 25,
"ageMax": 55,
"genders": [],
"publisherPlatforms": [
"facebook"
]
},
"dailyBudget": 10,
"durationDays": 7,
"delayHours": 0,
"publisherPlatforms": [
"facebook"
],
"archived": false,
"createdAt": "2026-01-15T10:00:00.000Z",
"updatedAt": "2026-01-15T10:00:00.000Z"
}
}
}Edita uma configuração de boost existente e não arquivada. Somente os campos fornecidos são alterados.
Atualizar uma configuração de boost
/api/v1/connections/boost-configs/update{
"data": {
"boostConfig": {
"id": "boost_1",
"connectionId": "conn_1",
"adAccountId": "adacct_1",
"name": "Local awareness — $15/day",
"platform": "facebook",
"targeting": {
"ageMin": 25,
"ageMax": 55,
"genders": [],
"publisherPlatforms": [
"facebook"
]
},
"dailyBudget": 15,
"durationDays": 7,
"delayHours": 0,
"publisherPlatforms": [
"facebook"
],
"archived": false,
"createdAt": "2026-01-15T10:00:00.000Z",
"updatedAt": "2026-02-01T09:00:00.000Z"
}
}
}Arquiva uma configuração de boost salva para que não apareça mais como uma predefinição reutilizável. Não afeta nenhum boost já em andamento criado a partir dela.
Arquivar uma configuração de boost
/api/v1/connections/boost-configs/archive{
"data": {
"archived": true
}
}Retorna os apps de negócio (CRMs e outras ferramentas de terceiros) que sua agência conectou através do Pipedream. Estes são de toda a agência — uma chave limitada a clientes específicos ainda vê a lista completa, já que não há propriedade por cliente de uma conexão de app.
Listar apps conectados
/api/v1/connections/apps{
"data": {
"connections": [],
"count": 0
}
}