Synupv1
Schlüssel erstellen
v1Ressourcen/Connections

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

get/api/v1/connections
connections:read
Query-Parameter
clientIdstringoptional
Ergebnisse auf einen Kunden beschränken. Ist Ihr Schlüssel auf bestimmte Kunden beschränkt, sind die Ergebnisse auch ohne diese Angabe immer auf diese Kunden vorgefiltert.
platformstringoptional
Ergebnisse auf eine Plattform beschränken, z. B. facebook, google.
credentialsValidbooleanoptional
Auf Konten beschränken, deren gespeicherte Zugangsdaten derzeit gültig (true) oder ungültig (false) sind.
fetchStatusstringoptional
Auf Konten mit diesem Abrufstatus beschränken.
cursorstringoptional
Paginierungs-Cursor aus dem nextCursor einer vorherigen Antwort.
limitintegeroptional
Maximal zurückzugebende Konten, 1–100. Standardmäßig 20.
Antwort
dataobjectoptional
accountsarray of objectoptional
Die passenden verbundenen Konten.
idstringoptional
Eindeutige Kennung des verbundenen Kontos.
platformstringoptional
Die Plattform, mit der dieses Konto verbunden ist, z. B. google, facebook, instagram.
displayNamestringoptional
Anzeigename des verbundenen Kontos.
providerAccountIdstringoptional
Die eigene Kennung der Plattform für dieses Konto.
credentialsValidbooleanoptional
Ob die gespeicherten Zugangsdaten derzeit gültig sind.
fetchStatusstringoptional
Aktueller Abrufstatus für dieses Konto, z. B. idle, fetching.
fetchErrorstringoptional
Die letzte Fehlermeldung beim Abruf, oder null.
errorTagstringoptional
Ein kurzer, maschinenlesbarer Fehlercode, oder null.
gmbGroupIdsarray of stringoptional
Google-Business-Profil-Gruppen-IDs, die mit diesem Konto verknüpft sind, falls vorhanden.
expiresAtstringoptional
Wann das Access Token dieses Kontos abläuft, als ISO-8601-Zeitstempel, oder null.
dataAccessExpiresAtstringoptional
Wann das Datenzugriffsfenster von Meta für dieses Konto abläuft, als ISO-8601-Zeitstempel, oder null.
channelstringoptional
Der Kanal, über den diese Verbindung hergestellt wurde.
clientIdstringoptional
ID des Kunden, zu dem dieses Konto gehört, oder null bei einer agenturweiten Verbindung.
synupLocationIdstringoptional
Legacy-Standortkennung. Veraltet — clientLocationId bevorzugen.
clientLocationIdstringoptional
ID des Standorts, an den dieses Konto gebunden ist, oder null. Gegenüber synupLocationId zu bevorzugen.
fetchedListingsCountnumberoptional
Anzahl der von diesem Konto abgerufenen Listings.
lastFetchedAtstringoptional
Wann dieses Konto zuletzt einen Abruf abgeschlossen hat, als ISO-8601-Zeitstempel, oder null.
connectionStatusstring (CONNECTED | MISSING | RENEW | DISCONNECTED | SUSPENDED | SUGGESTED_MATCH)optional
Gesamtzustand dieser Verbindung: CONNECTED, MISSING, RENEW, DISCONNECTED, SUSPENDED oder SUGGESTED_MATCH.
createdAtstringoptional
Wann dieses Konto verbunden wurde, als ISO-8601-Zeitstempel.
updatedAtstringoptional
Wann dieses Konto zuletzt aktualisiert wurde, als ISO-8601-Zeitstempel.
nextCursorstringoptional
Paginierungs-Cursor für die nächste Seite, oder null, wenn keine weiteren Ergebnisse vorliegen.
totalCountnumberoptional
Gesamtzahl der zur Anfrage passenden Konten.
Fehler
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
get/api/v1/connections
Ihr API-Schlüssel
clientId
platform
credentialsValid
fetchStatus
cursor
limit
{
  "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
  }
}
v1Ressourcen/Connections/getZusammenfassung verbundener Konten abrufen

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

get/api/v1/connections/summary
connections:read
Query-Parameter
clientIdstringoptional
Auf die Standorte eines Kunden beschränken.
tagsstringoptional
Kommagetrennte Standort-Tag-Namen — nur Standorte mit mindestens einem davon werden gezählt.
Antwort
dataobjectoptional
totalnumberoptional
Gesamtzahl der Standorte im Geltungsbereich.
googleobjectoptional
connectednumberoptional
Standorte mit verbundenem Publisher.
notConnectednumberoptional
Standorte ohne verbundenen Publisher.
facebookobjectoptional
connectednumberoptional
Standorte mit verbundenem Publisher.
notConnectednumberoptional
Standorte ohne verbundenen Publisher.
Fehler
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
get/api/v1/connections/summary
Ihr API-Schlüssel
clientId
tags
{
  "data": {
    "total": 5,
    "google": {
      "connected": 3,
      "notConnected": 2
    },
    "facebook": {
      "connected": 1,
      "notConnected": 4
    }
  }
}
v1Ressourcen/Connections/getGoogle-Verbindungs-URL abrufen

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

get/api/v1/connections/google/connect-url
connections:write
Query-Parameter
locationIdstringerforderlich
Der zu verbindende Standort.
clientIdstringoptional
Der Kunde des Standorts. Nur zur Eindeutigkeit nötig, wenn Ihr Schlüssel auf bestimmte Kunden beschränkt ist.
returnUrlstringoptional
App-interner Pfad, auf dem nach Abschluss des Zustimmungsbildschirms gelandet wird. Standard: "/".
Antwort
dataobjectoptional
providerstring (google | facebook)optional
Welcher Publisher mit dieser URL verbunden wird.
locationIdstringoptional
Der Standort, dem diese Verbindung nach Genehmigung zugeordnet wird.
urlstringoptional
Die Autorisierungs-URL — in einem Browser unter Kontrolle des Kontoinhabers öffnen.
notestringoptional
Erklärt, dass es keinen Rückruf an Ihre Integration gibt; danach GET /api/v1/connections abfragen.
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
get/api/v1/connections/google/connect-url
Ihr API-Schlüssel
locationId *
clientId
returnUrl
{
  "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."
  }
}
v1Ressourcen/Connections/getFacebook-Verbindungs-URL abrufen

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

get/api/v1/connections/facebook/connect-url
connections:write
Query-Parameter
locationIdstringerforderlich
Der zu verbindende Standort.
clientIdstringoptional
Der Kunde des Standorts. Nur zur Eindeutigkeit nötig, wenn Ihr Schlüssel auf bestimmte Kunden beschränkt ist.
returnUrlstringoptional
App-interner Pfad, auf dem nach Abschluss des Zustimmungsbildschirms gelandet wird. Standard: "/".
Antwort
dataobjectoptional
providerstring (google | facebook)optional
Welcher Publisher mit dieser URL verbunden wird.
locationIdstringoptional
Der Standort, dem diese Verbindung nach Genehmigung zugeordnet wird.
urlstringoptional
Die Autorisierungs-URL — in einem Browser unter Kontrolle des Kontoinhabers öffnen.
notestringoptional
Erklärt, dass es keinen Rückruf an Ihre Integration gibt; danach GET /api/v1/connections abfragen.
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
get/api/v1/connections/facebook/connect-url
Ihr API-Schlüssel
locationId *
clientId
returnUrl
{
  "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."
  }
}
v1Ressourcen/Connections/getWerbekonten auflisten

Liefert die auf einem verbundenen Konto verfügbaren Paid-Social-Werbekonten (Facebook, Instagram, LinkedIn oder TikTok).

Werbekonten auflisten

get/api/v1/connections/ad-accounts
connections:read
Query-Parameter
connectionIdstringerforderlich
Das abzurufende verbundene Konto. Erforderlich. Nachschlagen mit GET /api/v1/connections.
Antwort
dataobjectoptional
adAccountsarray of objectoptional
Die auf diesem verbundenen Konto verfügbaren Werbekonten.
idstringoptional
Eindeutige Kennung des Werbekontos.
connectionIdstringoptional
ID des verbundenen Kontos, zu dem dieses Werbekonto gehört.
platformAccountIdstringoptional
Die eigene Kennung der Plattform für dieses Werbekonto, z. B. act_226123609900306 für Meta.
namestringoptional
Anzeigename des Werbekontos.
platformstringoptional
Plattform, zu der dieses Werbekonto gehört: facebook, instagram, linkedin oder tiktok.
statusstring (active | disabled | unsettled | pending_review)optional
Von der Plattform gemeldeter Status: active, disabled, unsettled oder pending_review.
isSelectedbooleanoptional
Ob dies das für diese Verbindung aktuell zum Boosten ausgewählte Werbekonto ist.
currencystringoptional
Währung, in der dieses Werbekonto abrechnet, oder null.
archivedbooleanoptional
Ob dieses Werbekonto archiviert wurde.
createdAtstringoptional
Wann dieses Werbekonto erstmals synchronisiert wurde, als ISO-8601-Zeitstempel.
updatedAtstringoptional
Wann dieses Werbekonto zuletzt synchronisiert wurde, als ISO-8601-Zeitstempel.
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
get/api/v1/connections/ad-accounts
Ihr API-Schlüssel
connectionId *
{
  "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"
      }
    ]
  }
}
v1Ressourcen/Connections/postWerbekonten synchronisieren

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

post/api/v1/connections/ad-accounts/sync
connections:write
Anfragetext
connectionIdstringerforderlich
Das zu synchronisierende verbundene Konto. Erforderlich. Nachschlagen mit GET /api/v1/connections.
Antwort
dataobjectoptional
adAccountsarray of objectoptional
Die auf diesem verbundenen Konto verfügbaren Werbekonten.
idstringoptional
Eindeutige Kennung des Werbekontos.
connectionIdstringoptional
ID des verbundenen Kontos, zu dem dieses Werbekonto gehört.
platformAccountIdstringoptional
Die eigene Kennung der Plattform für dieses Werbekonto, z. B. act_226123609900306 für Meta.
namestringoptional
Anzeigename des Werbekontos.
platformstringoptional
Plattform, zu der dieses Werbekonto gehört: facebook, instagram, linkedin oder tiktok.
statusstring (active | disabled | unsettled | pending_review)optional
Von der Plattform gemeldeter Status: active, disabled, unsettled oder pending_review.
isSelectedbooleanoptional
Ob dies das für diese Verbindung aktuell zum Boosten ausgewählte Werbekonto ist.
currencystringoptional
Währung, in der dieses Werbekonto abrechnet, oder null.
archivedbooleanoptional
Ob dieses Werbekonto archiviert wurde.
createdAtstringoptional
Wann dieses Werbekonto erstmals synchronisiert wurde, als ISO-8601-Zeitstempel.
updatedAtstringoptional
Wann dieses Werbekonto zuletzt synchronisiert wurde, als ISO-8601-Zeitstempel.
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
422Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
post/api/v1/connections/ad-accounts/sync
Ihr API-Schlüssel
Anfragetext*
{
  "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"
      }
    ]
  }
}
v1Ressourcen/Connections/postEin Werbekonto auswählen

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

post/api/v1/connections/ad-accounts/select
connections:write
Anfragetext
connectionIdstringerforderlich
Das verbundene Konto, dem das Werbekonto gehört. Erforderlich. Nachschlagen mit GET /api/v1/connections.
adAccountIdstringerforderlich
Das auszuwählende Werbekonto. Muss zu connectionId gehören. Erforderlich.
Antwort
dataobjectoptional
selectedbooleanoptional
Bei Erfolg immer true.
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
post/api/v1/connections/ad-accounts/select
Ihr API-Schlüssel
Anfragetext*
{
  "data": {
    "selected": true
  }
}
v1Ressourcen/Connections/postEin Listing einem Standort zuweisen

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

post/api/v1/connections/locations/assign
connections:write
Anfragetext
platformstring (google | facebook)erforderlich
Die Plattform: google oder facebook. Erforderlich.
caIdstringerforderlich
Das bereits verbundene Konto, das verknüpft werden soll. Erforderlich.
locationIdstringerforderlich
Der Standort, dem dieses Listing zugewiesen wird. Erforderlich.
platformResourceNamestringerforderlich
Der Ressourcenname/die ID des Listings auf der Plattform. Erforderlich.
platformPageNamestringerforderlich
Der Anzeigename des Listings auf der Plattform. Erforderlich.
Antwort
dataobjectoptional
idstringoptional
Eindeutige Kennung der resultierenden Verbindung.
platformstring (google | facebook)optional
Die Plattform, auf der das Listing verknüpft wurde.
synupLocationIdstringoptional
Die Legacy-Synup-ID des Standorts, oder null bei einem nativen Standort.
clientLocationIdstringoptional
Die ID des Standorts.
platformResourceNamestringoptional
Der Ressourcenname/die ID des Listings auf der Plattform.
platformPageNamestringoptional
Der Anzeigename des Listings auf der Plattform.
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
post/api/v1/connections/locations/assign
Ihr API-Schlüssel
Anfragetext*
{
  "data": {
    "id": "listing_1",
    "platform": "google",
    "synupLocationId": null,
    "clientLocationId": "loc_456",
    "platformResourceName": "accounts/123/locations/456",
    "platformPageName": "Acme Dental — Downtown"
  }
}
v1Ressourcen/Connections/postEinen vorgeschlagenen Treffer bestätigen

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

post/api/v1/connections/locations/confirm-match
connections:write
Anfragetext
fetchedListingIdstringerforderlich
Das zu bestätigende abgerufene Listing. Erforderlich.
Antwort
dataobjectoptional
idstringoptional
Eindeutige Kennung der resultierenden Verbindung.
platformstring (google | facebook)optional
Die Plattform, auf der das Listing verknüpft wurde.
synupLocationIdstringoptional
Die Legacy-Synup-ID des Standorts, oder null bei einem nativen Standort.
clientLocationIdstringoptional
Die ID des Standorts.
platformResourceNamestringoptional
Der Ressourcenname/die ID des Listings auf der Plattform.
platformPageNamestringoptional
Der Anzeigename des Listings auf der Plattform.
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
409Die Anfrage steht im Widerspruch zum aktuellen Zustand der Ressource — zum Beispiel beim Ändern der E-Mail-Adresse oder Telefonnummer eines Empfängers, dem bereits eine Nachricht gesendet wurde, oder bei einer Team-Einladung, die bereits akzeptiert wurde (oder noch nicht akzeptiert wurde).
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
post/api/v1/connections/locations/confirm-match
Ihr API-Schlüssel
Anfragetext*
{
  "data": {
    "id": "listing_1",
    "platform": "google",
    "synupLocationId": null,
    "clientLocationId": "loc_456",
    "platformResourceName": "accounts/123/locations/456",
    "platformPageName": "Acme Dental — Downtown"
  }
}
v1Ressourcen/Connections/postNeue Übereinstimmungsvorschläge anfordern

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

post/api/v1/connections/request-matches
connections:write
Anfragetext
connectionIdstringerforderlich
Das erneut zu bewertende verbundene Konto. Erforderlich. Nachschlagen mit GET /api/v1/connections.
Antwort
dataobjectoptional
scorednumberoptional
Anzahl der erneut bewerteten Listings.
messagestringoptional
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
post/api/v1/connections/request-matches
Ihr API-Schlüssel
Anfragetext*
{
  "data": {
    "scored": 4,
    "message": null
  }
}
v1Ressourcen/Connections/postListings eines Kontos erzwungen erneut abrufen

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

post/api/v1/connections/fetch-listings
connections:write
Anfragetext
connectionIdstringerforderlich
Das erneut abzurufende verbundene Konto. Erforderlich. Nachschlagen mit GET /api/v1/connections.
Antwort
dataobjectoptional
statusstringoptional
countnumberoptional
Anzahl der abgerufenen Listings.
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
post/api/v1/connections/fetch-listings
Ihr API-Schlüssel
Anfragetext*
{
  "data": {
    "status": "completed",
    "count": 4
  }
}
v1Ressourcen/Connections/getBoost-Konfigurationen auflisten

Liefert die gespeicherten Boost-Konfigurationen (wiederverwendbare Targeting- und Budgetvorlagen zum Boosten eines Beitrags) auf einem verbundenen Konto.

Boost-Konfigurationen auflisten

get/api/v1/connections/boost-configs
connections:read
Query-Parameter
connectionIdstringerforderlich
Das abzurufende verbundene Konto. Erforderlich. Nachschlagen mit GET /api/v1/connections.
Antwort
dataobjectoptional
boostConfigsarray of objectoptional
Die auf diesem verbundenen Konto gespeicherten Boost-Konfigurationen.
idstringoptional
Eindeutige Kennung der Boost-Konfiguration.
connectionIdstringoptional
ID des verbundenen Kontos, zu dem diese Boost-Konfiguration gehört.
adAccountIdstringoptional
ID des Werbekontos, aus dem diese Boost-Konfiguration ausgibt.
namestringoptional
Name dieser Vorlage.
platformstringoptional
Plattform, auf der diese Boost-Konfiguration läuft, passend zu ihrem verbundenen Konto.
targetingobjectoptional
Targeting-Einstellungen für diese Vorlage.
ageMinnumberoptional
Mindestalter der Zielgruppe.
ageMaxnumberoptional
Höchstalter der Zielgruppe.
gendersarray of numberoptional
Anzusprechende Geschlechter der Zielgruppe: 1 für männlich, 2 für weiblich.
geoLocationsobjectoptional
Geografisches Targeting: Länder, Regionen, Städte und/oder Postleitzahlen.
interestsarray of objectoptional
Anzusprechende Interessenkategorien.
publisherPlatformsarray of stringoptional
Auf welchen Plattform-Oberflächen die Zielgruppe angesprochen werden soll, z. B. ["facebook", "instagram"].
pageFansstring (fans | fans_of_fans)optional
Die Zielgruppe auf Personen beschränken, denen die Seite gefällt (Fans), oder zusätzlich auf deren Freunde (fans_of_fans).
dailyBudgetnumberoptional
Tagesbudget, in der kleinsten Währungseinheit der Plattform (z. B. Cent).
durationDaysnumberoptional
Wie viele Tage der Boost nach Anwendung läuft.
delayHoursnumberoptional
Stunden, die nach Veröffentlichung eines Beitrags gewartet wird, bevor er geboostet wird.
publisherPlatformsarray of stringoptional
Auf welchen Plattform-Oberflächen diese Vorlage boostet.
archivedbooleanoptional
Ob diese Vorlage archiviert wurde.
createdAtstringoptional
Wann diese Vorlage erstellt wurde, als ISO-8601-Zeitstempel.
updatedAtstringoptional
Wann diese Vorlage zuletzt aktualisiert wurde, als ISO-8601-Zeitstempel.
adAccountobjectoptional
Eine kurze Zusammenfassung des Werbekontos, aus dem diese Vorlage ausgibt, oder null.
platformAccountIdstringoptional
Die eigene Kennung der Plattform für dieses Werbekonto.
namestringoptional
Anzeigename dieses Werbekontos.
currencystringoptional
Währung, in der dieses Werbekonto abrechnet, oder null.
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
get/api/v1/connections/boost-configs
Ihr API-Schlüssel
connectionId *
{
  "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"
      }
    ]
  }
}
v1Ressourcen/Connections/postBoost-Konfiguration erstellen

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

post/api/v1/connections/boost-configs
connections:write
Anfragetext
connectionIdstringerforderlich
Das verbundene Konto, an das diese Boost-Konfiguration angehängt werden soll. Erforderlich. Nachschlagen mit GET /api/v1/connections.
adAccountIdstringerforderlich
Das Werbekonto, aus dem ausgegeben werden soll, wenn diese Konfiguration verwendet wird. Muss zu connectionId gehören. Erforderlich.
namestringerforderlich
Ein Name für diese Vorlage, angezeigt bei der späteren Auswahl. Erforderlich.
targetingobjectoptional
Alle Felder sind optional. Ein leeres Objekt zielt auf die breiteste Standard-Zielgruppe der Plattform ab.
ageMinnumberoptional
Mindestalter der Zielgruppe.
ageMaxnumberoptional
Höchstalter der Zielgruppe.
gendersarray of numberoptional
Anzusprechende Geschlechter der Zielgruppe: 1 für männlich, 2 für weiblich.
geoLocationsobjectoptional
Geografisches Targeting: Länder, Regionen, Städte und/oder Postleitzahlen.
countriesarray of stringoptional
regionsarray of objectoptional
keystringoptional
namestringoptional
citiesarray of objectoptional
keystringoptional
namestringoptional
radiusnumberoptional
distanceUnitstringoptional
zipsarray of objectoptional
keystringoptional
namestringoptional
interestsarray of objectoptional
Anzusprechende Interessenkategorien.
idstringoptional
namestringoptional
publisherPlatformsarray of stringoptional
Auf welchen Plattform-Oberflächen die Zielgruppe angesprochen werden soll, z. B. ["facebook", "instagram"].
pageFansstring (fans | fans_of_fans)optional
Die Zielgruppe auf Personen beschränken, denen die Seite gefällt (Fans), oder zusätzlich auf deren Freunde (fans_of_fans).
dailyBudgetnumbererforderlich
Tagesbudget, in der kleinsten Währungseinheit der Plattform (z. B. Cent). Muss positiv sein. Erforderlich.
durationDaysnumbererforderlich
Wie viele Tage der Boost nach Anwendung laufen soll. Muss positiv sein. Erforderlich.
delayHoursnumberoptional
Stunden, die nach Veröffentlichung eines Beitrags gewartet werden soll, bevor er geboostet wird. Standardmäßig 0.
publisherPlatformsarray of stringoptional
Auf welchen Plattform-Oberflächen geboostet werden soll, z. B. ["facebook", "instagram"].
Antwort
dataobjectoptional
boostConfigobjectoptional
idstringoptional
Eindeutige Kennung der Boost-Konfiguration.
connectionIdstringoptional
ID des verbundenen Kontos, zu dem diese Boost-Konfiguration gehört.
adAccountIdstringoptional
ID des Werbekontos, aus dem diese Boost-Konfiguration ausgibt.
namestringoptional
Name dieser Vorlage.
platformstringoptional
Plattform, auf der diese Boost-Konfiguration läuft, passend zu ihrem verbundenen Konto.
targetingobjectoptional
Targeting-Einstellungen für diese Vorlage.
ageMinnumberoptional
Mindestalter der Zielgruppe.
ageMaxnumberoptional
Höchstalter der Zielgruppe.
gendersarray of numberoptional
Anzusprechende Geschlechter der Zielgruppe: 1 für männlich, 2 für weiblich.
geoLocationsobjectoptional
Geografisches Targeting: Länder, Regionen, Städte und/oder Postleitzahlen.
interestsarray of objectoptional
Anzusprechende Interessenkategorien.
publisherPlatformsarray of stringoptional
Auf welchen Plattform-Oberflächen die Zielgruppe angesprochen werden soll, z. B. ["facebook", "instagram"].
pageFansstring (fans | fans_of_fans)optional
Die Zielgruppe auf Personen beschränken, denen die Seite gefällt (Fans), oder zusätzlich auf deren Freunde (fans_of_fans).
dailyBudgetnumberoptional
Tagesbudget, in der kleinsten Währungseinheit der Plattform (z. B. Cent).
durationDaysnumberoptional
Wie viele Tage der Boost nach Anwendung läuft.
delayHoursnumberoptional
Stunden, die nach Veröffentlichung eines Beitrags gewartet wird, bevor er geboostet wird.
publisherPlatformsarray of stringoptional
Auf welchen Plattform-Oberflächen diese Vorlage boostet.
archivedbooleanoptional
Ob diese Vorlage archiviert wurde.
createdAtstringoptional
Wann diese Vorlage erstellt wurde, als ISO-8601-Zeitstempel.
updatedAtstringoptional
Wann diese Vorlage zuletzt aktualisiert wurde, als ISO-8601-Zeitstempel.
adAccountobjectoptional
Eine kurze Zusammenfassung des Werbekontos, aus dem diese Vorlage ausgibt, oder null.
platformAccountIdstringoptional
Die eigene Kennung der Plattform für dieses Werbekonto.
namestringoptional
Anzeigename dieses Werbekontos.
currencystringoptional
Währung, in der dieses Werbekonto abrechnet, oder null.
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
post/api/v1/connections/boost-configs
Ihr API-Schlüssel
Anfragetext*
{
  "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"
    }
  }
}
v1Ressourcen/Connections/postBoost-Konfiguration aktualisieren

Bearbeitet eine bestehende, nicht archivierte Boost-Konfiguration. Nur die von Ihnen angegebenen Felder werden geändert.

Boost-Konfiguration aktualisieren

post/api/v1/connections/boost-configs/update
connections:write
Anfragetext
connectionIdstringerforderlich
Das verbundene Konto, dem die Boost-Konfiguration gehört. Erforderlich. Nachschlagen mit GET /api/v1/connections.
configIdstringerforderlich
Die zu aktualisierende Boost-Konfiguration. Muss zu connectionId gehören und darf nicht archiviert sein. Erforderlich.
adAccountIdstringoptional
Neues Werbekonto, aus dem ausgegeben werden soll, falls geändert.
namestringoptional
Neuer Name für diese Vorlage, falls geändert.
targetingobjectoptional
Alle Felder sind optional. Ein leeres Objekt zielt auf die breiteste Standard-Zielgruppe der Plattform ab.
ageMinnumberoptional
Mindestalter der Zielgruppe.
ageMaxnumberoptional
Höchstalter der Zielgruppe.
gendersarray of numberoptional
Anzusprechende Geschlechter der Zielgruppe: 1 für männlich, 2 für weiblich.
geoLocationsobjectoptional
Geografisches Targeting: Länder, Regionen, Städte und/oder Postleitzahlen.
countriesarray of stringoptional
regionsarray of objectoptional
keystringoptional
namestringoptional
citiesarray of objectoptional
keystringoptional
namestringoptional
radiusnumberoptional
distanceUnitstringoptional
zipsarray of objectoptional
keystringoptional
namestringoptional
interestsarray of objectoptional
Anzusprechende Interessenkategorien.
idstringoptional
namestringoptional
publisherPlatformsarray of stringoptional
Auf welchen Plattform-Oberflächen die Zielgruppe angesprochen werden soll, z. B. ["facebook", "instagram"].
pageFansstring (fans | fans_of_fans)optional
Die Zielgruppe auf Personen beschränken, denen die Seite gefällt (Fans), oder zusätzlich auf deren Freunde (fans_of_fans).
dailyBudgetnumberoptional
Neues Tagesbudget, in der kleinsten Währungseinheit der Plattform, falls geändert.
durationDaysnumberoptional
Neue Laufzeit in Tagen, falls geändert.
delayHoursnumberoptional
Neue Verzögerung in Stunden vor dem Boosten, falls geändert.
publisherPlatformsarray of stringoptional
Neue Liste der Plattform-Oberflächen zum Boosten, falls geändert.
Antwort
dataobjectoptional
boostConfigobjectoptional
idstringoptional
Eindeutige Kennung der Boost-Konfiguration.
connectionIdstringoptional
ID des verbundenen Kontos, zu dem diese Boost-Konfiguration gehört.
adAccountIdstringoptional
ID des Werbekontos, aus dem diese Boost-Konfiguration ausgibt.
namestringoptional
Name dieser Vorlage.
platformstringoptional
Plattform, auf der diese Boost-Konfiguration läuft, passend zu ihrem verbundenen Konto.
targetingobjectoptional
Targeting-Einstellungen für diese Vorlage.
ageMinnumberoptional
Mindestalter der Zielgruppe.
ageMaxnumberoptional
Höchstalter der Zielgruppe.
gendersarray of numberoptional
Anzusprechende Geschlechter der Zielgruppe: 1 für männlich, 2 für weiblich.
geoLocationsobjectoptional
Geografisches Targeting: Länder, Regionen, Städte und/oder Postleitzahlen.
interestsarray of objectoptional
Anzusprechende Interessenkategorien.
publisherPlatformsarray of stringoptional
Auf welchen Plattform-Oberflächen die Zielgruppe angesprochen werden soll, z. B. ["facebook", "instagram"].
pageFansstring (fans | fans_of_fans)optional
Die Zielgruppe auf Personen beschränken, denen die Seite gefällt (Fans), oder zusätzlich auf deren Freunde (fans_of_fans).
dailyBudgetnumberoptional
Tagesbudget, in der kleinsten Währungseinheit der Plattform (z. B. Cent).
durationDaysnumberoptional
Wie viele Tage der Boost nach Anwendung läuft.
delayHoursnumberoptional
Stunden, die nach Veröffentlichung eines Beitrags gewartet wird, bevor er geboostet wird.
publisherPlatformsarray of stringoptional
Auf welchen Plattform-Oberflächen diese Vorlage boostet.
archivedbooleanoptional
Ob diese Vorlage archiviert wurde.
createdAtstringoptional
Wann diese Vorlage erstellt wurde, als ISO-8601-Zeitstempel.
updatedAtstringoptional
Wann diese Vorlage zuletzt aktualisiert wurde, als ISO-8601-Zeitstempel.
adAccountobjectoptional
Eine kurze Zusammenfassung des Werbekontos, aus dem diese Vorlage ausgibt, oder null.
platformAccountIdstringoptional
Die eigene Kennung der Plattform für dieses Werbekonto.
namestringoptional
Anzeigename dieses Werbekontos.
currencystringoptional
Währung, in der dieses Werbekonto abrechnet, oder null.
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
post/api/v1/connections/boost-configs/update
Ihr API-Schlüssel
Anfragetext*
{
  "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"
    }
  }
}
v1Ressourcen/Connections/postBoost-Konfiguration archivieren

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

post/api/v1/connections/boost-configs/archive
connections:write
Anfragetext
connectionIdstringerforderlich
Das verbundene Konto, dem die Boost-Konfiguration gehört. Erforderlich. Nachschlagen mit GET /api/v1/connections.
configIdstringerforderlich
Die zu archivierende Boost-Konfiguration. Muss zu connectionId gehören. Erforderlich.
Antwort
dataobjectoptional
archivedbooleanoptional
Bei Erfolg immer true.
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
post/api/v1/connections/boost-configs/archive
Ihr API-Schlüssel
Anfragetext*
{
  "data": {
    "archived": true
  }
}
v1Ressourcen/Connections/getVerbundene Apps auflisten

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

get/api/v1/connections/apps
connections:read
Query-Parameter
appSlugstringoptional
Ergebnisse auf eine App beschränken, über deren Slug.
Antwort
dataobjectoptional
connectionsarray of objectoptional
Die über Pipedream verbundenen Business-Apps.
appstringoptional
Der identifizierende Slug der App.
appNamestringoptional
Anzeigename der App.
accountstringoptional
Bezeichnung des verbundenen Kontos innerhalb dieser App, oder null.
statusstringoptional
Aktueller Verbindungsstatus.
errorstringoptional
Der letzte Verbindungsfehler, oder null.
connectedAtstringoptional
Wann diese App verbunden wurde, als ISO-8601-Zeitstempel.
lastCheckedAtstringoptional
Wann diese Verbindung zuletzt auf Funktionsfähigkeit geprüft wurde, als ISO-8601-Zeitstempel, oder null.
countnumberoptional
Gesamtzahl der zur Anfrage passenden verbundenen Apps.
Fehler
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
get/api/v1/connections/apps
Ihr API-Schlüssel
appSlug
{
  "data": {
    "connections": [],
    "count": 0
  }
}