Connections
Verwalten der verbundenen Publisher- und Social-Konten Ihrer Agentur, ihrer Werbekonten, Boost-Konfigurationsvorlagen und verbundenen Business-Apps.
Liefert die verbundenen Publisher-/Social-Konten Ihrer Agentur (Google, Facebook, Instagram, LinkedIn, TikTok und weitere), optional gefiltert nach Kunde oder Plattform.
Verbundene Konten auflisten
/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
}
}Wie viele Standorte dieses Kunden (oder der gesamten Agentur) Google/Facebook verbunden haben oder nicht. Mit tags auf eine Teilmenge eingrenzen.
Zusammenfassung verbundener Konten abrufen
/api/v1/connections/summary{
"data": {
"total": 5,
"google": {
"connected": 3,
"notConnected": 2
},
"facebook": {
"connected": 1,
"notConnected": 4
}
}
}Gibt eine Google-OAuth-Autorisierungs-URL zurück, die in einem Browser geöffnet wird, um das Google-Unternehmensprofil dieses Standorts zu verbinden. Dieser Endpunkt kann die Verbindung nicht selbst abschließen — der Google-Zustimmungsbildschirm erfordert einen interaktiven Menschen.
Google-Verbindungs-URL abrufen
/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."
}
}Gibt eine Facebook-OAuth-Autorisierungs-URL zurück, die in einem Browser geöffnet wird, um die Facebook-Seite dieses Standorts zu verbinden. Dieser Endpunkt kann die Verbindung nicht selbst abschließen — der Facebook-Zustimmungsbildschirm erfordert einen interaktiven Menschen.
Facebook-Verbindungs-URL abrufen
/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."
}
}Liefert die auf einem verbundenen Konto verfügbaren Paid-Social-Werbekonten (Facebook, Instagram, LinkedIn oder TikTok).
Werbekonten auflisten
/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"
}
]
}
}Erzwingt einen sofortigen erneuten Abruf der Werbekonten eines verbundenen Kontos von der Plattform, statt auf die tägliche Hintergrundsynchronisierung zu warten. Liefert die aktualisierte Liste zurück.
Werbekonten synchronisieren
/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"
}
]
}
}Legt fest, welches der Werbekonten eines verbundenen Kontos beim Boosten von Beiträgen verwendet wird. Pro verbundenem Konto kann jeweils nur ein Werbekonto ausgewählt sein.
Ein Werbekonto auswählen
/api/v1/connections/ad-accounts/select{
"data": {
"selected": true
}
}Verknüpft ein bereits abgerufenes Listing eines bereits verbundenen Kontos mit einem Standort, der noch keine eigene Verbindung hat. Kein neuer OAuth-Grant — caId muss bereits ein verbundenes Konto sein; dies verwendet diesen Login weiter. Nur Google und Facebook.
Ein Listing einem Standort zuweisen
/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"
}
}Bestätigt einen Vorschlag der NAP-Bewertung und erstellt eine Verbindung auf Standortebene aus einem abgerufenen Listing, das bereits einem Synup-Standort zugeordnet wurde. Schlägt fehl, wenn das Listing keinem Standort zugeordnet ist (400), bereits verbunden ist (409) oder der Standort bereits eine Verbindung auf dieser Plattform hat (409).
Einen vorgeschlagenen Treffer bestätigen
/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"
}
}Führt die NAP-Bewertung (Name/Adresse/Telefon) für die bereits abgerufenen Listings eines verbundenen Kontos erneut aus. Ruft nicht erneut von der Plattform ab — dafür POST /api/v1/connections/fetch-listings verwenden. Begrenzt auf einmal alle 24 Stunden pro Konto; ein Aufruf innerhalb dieses Zeitfensters liefert 429 mit einem retryAt-Zeitstempel.
Neue Übereinstimmungsvorschläge anfordern
/api/v1/connections/request-matches{
"data": {
"scored": 4,
"message": null
}
}Erzwingt einen sofortigen erneuten Abruf der Listings eines verbundenen Kontos direkt von der Plattform — nicht nur eine erneute Bewertung des bereits Gespeicherten, das ist POST /api/v1/connections/request-matches. Läuft synchron; die Antwort bestätigt, dass der Abruf bereits abgeschlossen ist.
Listings eines Kontos erzwungen erneut abrufen
/api/v1/connections/fetch-listings{
"data": {
"status": "completed",
"count": 4
}
}Liefert die gespeicherten Boost-Konfigurationen (wiederverwendbare Targeting- und Budgetvorlagen zum Boosten eines Beitrags) auf einem verbundenen Konto.
Boost-Konfigurationen auflisten
/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"
}
]
}
}Speichert eine neue wiederverwendbare Boost-Konfiguration (Targeting, Tagesbudget und Laufzeit) auf dem Werbekonto eines verbundenen Kontos. Dies speichert lediglich eine Vorlage für die spätere Verwendung — es boostet dabei selbst keinen Beitrag, übermittelt nichts an die Werbeplattform und gibt kein Geld aus. Geld wird erst ausgegeben, wenn diese gespeicherte Konfiguration später auf einen bestimmten Beitrag angewendet wird, um ihn zu boosten.
Boost-Konfiguration erstellen
/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"
}
}
}Bearbeitet eine bestehende, nicht archivierte Boost-Konfiguration. Nur die von Ihnen angegebenen Felder werden geändert.
Boost-Konfiguration aktualisieren
/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"
}
}
}Archiviert eine gespeicherte Boost-Konfiguration, sodass sie nicht mehr als wiederverwendbare Vorlage erscheint. Betrifft keinen bereits laufenden Boost, der daraus erstellt wurde.
Boost-Konfiguration archivieren
/api/v1/connections/boost-configs/archive{
"data": {
"archived": true
}
}Liefert die Business-Apps (CRMs und andere Drittanbieter-Tools), die Ihre Agentur über Pipedream verbunden hat. Diese sind agenturweit — auch ein auf bestimmte Kunden beschränkter Schlüssel sieht die vollständige Liste, da es kein kundenspezifisches Eigentum an einer App-Verbindung gibt.
Verbundene Apps auflisten
/api/v1/connections/apps{
"data": {
"connections": [],
"count": 0
}
}