Synupv1
Schlüssel erstellen
v1Ressourcen/Clients

Clients

Erstellen, lesen, aktualisieren und archivieren Sie die Kunden (Unternehmen) in Ihrer Agentur.

Liefert eine Seite der Kunden Ihrer Agentur, zuletzt erstellte zuerst. Alle Filter sind optional und werden kombiniert (ein Kunde muss allen entsprechen); um weitere Ergebnisse zu blättern, geben Sie den zurückgegebenen nextCursor erneut mit.

Clients auflisten / suchen

get/api/v1/clients
clients:read
Query-Parameter
searchstringoptional
Freitextsuche über Firmenname, Branche oder primäre Kontakt-E-Mail des Kunden (Groß-/Kleinschreibung wird ignoriert, Teiltreffer erlaubt).
statusarray of string (complete | draft)optional
Auf einen oder mehrere Status einschränken: complete (aktiv, vollständig onboardet) oder draft (noch in Einrichtung).
representativeIdsarray of stringoptional
Auf Kunden einschränken, die einer oder mehreren dieser Teammitglieds-IDs zugewiesen sind — siehe GET /api/v1/team/members für die Mitglieds-IDs Ihrer Agentur.
goalsarray of string (improve_rankings | get_reviews | fix_listings)optional
Auf ein oder mehrere primäre Ziele des Kunden einschränken: improve_rankings, get_reviews oder fix_listings.
healthMinnumberoptional
Niedrigster einzuschließender Gesundheitswert, 0–100.
healthMaxnumberoptional
Höchster einzuschließender Gesundheitswert, 0–100.
locationsMinnumberoptional
Mindestanzahl an Standorten, die ein Kunde haben muss, um eingeschlossen zu werden.
locationsMaxnumberoptional
Höchstanzahl an Standorten, die ein Kunde haben darf und trotzdem eingeschlossen wird.
createdAfterstringoptional
Nur Kunden, die an oder nach diesem Datum erstellt wurden.
createdBeforestringoptional
Nur Kunden, die an oder vor diesem Datum erstellt wurden.
cursorstringoptional
Paginierungs-Cursor aus dem nextCursor einer vorherigen Antwort. Für die erste Seite leer lassen.
limitintegeroptional
Kunden pro Seite, 1–200. Standardmäßig 50.
Antwort
dataobjectoptional
clientsarray of objectoptional
Die zu dieser Seite passenden Kunden.
idstringoptional
Eindeutige Kennung des Kunden.
businessNamestringoptional
Der Firmenname des Kunden.
industrystringoptional
Die Branche des Kunden.
statusstring (complete | draft)optional
Onboarding-Status: complete (aktiv) oder draft.
goalstring (improve_rankings | get_reviews | fix_listings)optional
Das primäre Ziel des Kunden, oder null.
healthScorenumberoptional
Ein Wert von 0–100, der den Kontostatus des Kunden zusammenfasst, oder null, falls noch nicht berechnet.
locationCountnumberoptional
Anzahl der Standorte dieses Kunden, oder null, falls unbekannt.
googleRatingnumberoptional
Die aktuelle Google-Sternebewertung des Kunden, oder null.
googleReviewCountnumberoptional
Die aktuelle Anzahl der Google-Bewertungen des Kunden, oder null.
planNamestringoptional
Name des Plans, auf dem dieser Kunde läuft, falls vorhanden.
createdAtstringoptional
Zeitpunkt der Erstellung des Kunden, als ISO-8601-Zeitstempel.
archivedbooleanoptional
Ob der Kunde archiviert ist.
archivedAtstringoptional
Zeitpunkt der Archivierung des Kunden, als ISO-8601-Zeitstempel, oder null.
scheduledArchiveAtstringoptional
Zeitpunkt, zu dem die Archivierung angefordert wurde (zugleich das Kohorten-Token, um sie abzubrechen), als ISO-8601-Zeitstempel, oder null, wenn keine ausstehend ist.
primaryRepresentativeobjectoptional
Das für diesen Kunden verantwortliche Teammitglied, oder null.
idstringoptional
firstNamestringoptional
lastNamestringoptional
emailstringoptional
nextCursorstringoptional
Paginierungs-Cursor für die nächste Seite, oder null, wenn keine weiteren Ergebnisse vorliegen.
totalnumberoptional
Gesamtzahl der Kunden, die den Filtern entsprechen, über alle Seiten hinweg.
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/clients
Ihr API-Schlüssel
search
status
representativeIds
goals
healthMin
healthMax
locationsMin
locationsMax
createdAfter
createdBefore
cursor
limit
{
  "data": {
    "clients": [
      {
        "id": "cli_123",
        "businessName": "Acme Dental",
        "industry": "Dental",
        "status": "complete",
        "goal": "get_reviews",
        "healthScore": 82,
        "locationCount": 1,
        "googleRating": 4.8,
        "googleReviewCount": 26,
        "archived": false,
        "archivedAt": null,
        "scheduledArchiveAt": null,
        "packageType": null,
        "planName": null,
        "createdAt": "2026-01-15T10:00:00.000Z",
        "primaryRepresentative": {
          "id": "usr_123",
          "firstName": "Jamie",
          "lastName": "Lee",
          "email": "jamie@youragency.com"
        }
      }
    ],
    "nextCursor": null,
    "total": 1
  }
}
v1Ressourcen/Clients/postClient erstellen

Erstellt einen neuen Kunden in Ihrer Agentur sowie einen ersten Standort, sobald sich die Adressangaben einem echten Ort zuordnen lassen.

Client erstellen

post/api/v1/clients
clients:write
Anfragetext
businessNamestringerforderlich
Der Firmenname für den neuen Kunden.
primaryContactEmailstringerforderlich
E-Mail-Adresse der primären Kontaktperson des Kunden.
primaryRepresentativeIdstringerforderlich
ID des Teammitglieds, das für diesen Kunden verantwortlich ist — siehe GET /api/v1/team/members für die Mitglieds-IDs Ihrer Agentur.
websitestringoptional
Die Website-URL des Kunden.
industrystringoptional
Die Branche des Kunden.
goalstring (improve_rankings | get_reviews | fix_listings)optional
Das primäre Ziel des Kunden: improve_rankings, get_reviews oder fix_listings.
gbpLinkstringoptional
Die Google-Unternehmensprofil-URL des Kunden.
placeIdstringoptional
Die Google-Place-ID des Kunden, aus Googles Places API — Synup bietet keine eigene Orts-Suche. Erstellt außerdem den ersten Standort des Kunden — führen Sie dafür nicht separat eine Standort-Erstellung für dasselbe Unternehmen aus.
latitudenumberoptional
Der Breitengrad des Kundenstandorts. Zusammen mit placeId und longitude erforderlich, um auch ein Schlüsselwort zu verfolgen.
longitudenumberoptional
Der Längengrad des Kundenstandorts.
googleRatingnumberoptional
Die aktuelle Google-Sternebewertung des Kunden, falls bekannt.
googleReviewCountnumberoptional
Die aktuelle Anzahl der Google-Bewertungen des Kunden, falls bekannt.
trackingKeywordstringoptional
Ein Schlüsselwort, um das lokale Suchranking des Kunden zu verfolgen. Erfordert, dass placeId, latitude und longitude ebenfalls gesetzt sind.
clientPlanIdstringoptional
Welcher Kundenportal-Plan zugewiesen werden soll. Standardmäßig der Standardplan Ihrer Agentur. Es gibt keinen Endpunkt, der Pläne auflistet — entnehmen Sie eine gültige ID aus der clientPlan.id eines bestehenden Kunden oder aus den Plan-Einstellungen Ihrer Agentur in Synup.
notesstringoptional
Eine interne Notiz zum Kunden — nur für Ihr Team sichtbar, niemals für den Kunden.
Antwort
dataobjectoptional
clientobjectoptional
Es können weitere interne Felder vorhanden sein, die nicht Teil des stabilen Vertrags sind — verlassen Sie sich nur auf die hier dokumentierten Felder.
idstringoptional
Eindeutige Kennung des Kunden.
businessNamestringoptional
Der Firmenname des Kunden.
websitestringoptional
Die Website-URL des Kunden.
industrystringoptional
Die Branche des Kunden.
primaryContactEmailstringoptional
E-Mail-Adresse der primären Kontaktperson des Kunden.
primaryRepresentativeIdstringoptional
ID des Teammitglieds, das für diesen Kunden verantwortlich ist — siehe GET /api/v1/team/members für die Mitglieds-IDs Ihrer Agentur.
visibilitystring (public | private)optional
Ob der Kunde innerhalb Ihrer Agentur public oder private ist.
goalstring (improve_rankings | get_reviews | fix_listings)optional
Das primäre Ziel des Kunden, oder null.
notesstringoptional
Eine interne Notiz zum Kunden — nur für Ihr Team sichtbar, niemals für den Kunden.
gbpLinkstringoptional
Die Google-Unternehmensprofil-URL des Kunden, oder null.
trackingKeywordstringoptional
Ein für das lokale Suchranking dieses Kunden verfolgtes Schlüsselwort, oder null.
healthScorenumberoptional
Ein Wert von 0–100, der den Kontostatus des Kunden zusammenfasst, oder null, falls noch nicht berechnet.
planNamestringoptional
Name des Plans, auf dem dieser Kunde läuft, falls vorhanden.
archivedbooleanoptional
Ob der Kunde archiviert ist.
archivedAtstringoptional
Zeitpunkt der Archivierung des Kunden, als ISO-8601-Zeitstempel, oder null.
scheduledArchiveAtstringoptional
Zeitpunkt, zu dem die Archivierung angefordert wurde (zugleich das Kohorten-Token, um sie abzubrechen), als ISO-8601-Zeitstempel, oder null, wenn keine ausstehend ist.
createdAtstringoptional
Zeitpunkt der Erstellung des Kunden, als ISO-8601-Zeitstempel.
updatedAtstringoptional
Zeitpunkt der letzten Aktualisierung des Kunden, als ISO-8601-Zeitstempel.
locationIdstringoptional
ID des zusammen mit diesem Kunden erstellten ersten Standorts, oder null, falls noch keiner erstellt werden konnte.
locationSkippedstring (place_not_found | missing_country | location_limit | missing_category | failed)optional
Warum kein erster Standort erstellt wurde, wenn eine placeId angegeben war, aber kein Standort entstand — zum Beispiel bedeutet location_limit, dass die Agentur ihr Plan-Standortlimit erreicht hat. Null, wenn nicht zutreffend.
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.
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/clients
Ihr API-Schlüssel
Anfragetext*
{
  "data": {
    "client": {
      "id": "cli_123",
      "businessName": "Acme Dental",
      "website": null,
      "industry": null,
      "primaryContactEmail": "owner@acmedental.com",
      "primaryRepresentativeId": "usr_123",
      "visibility": "public",
      "goal": null,
      "notes": null,
      "gbpLink": null,
      "trackingKeyword": null,
      "healthScore": null,
      "planName": null,
      "archived": false,
      "archivedAt": null,
      "scheduledArchiveAt": null,
      "createdAt": "2026-01-15T10:00:00.000Z",
      "updatedAt": "2026-01-15T10:00:00.000Z"
    },
    "locationId": "loc_456",
    "locationSkipped": null
  }
}
v1Ressourcen/Clients/getClient abrufen

Liefert vollständige Details zu einem Kunden: Unternehmensprofil, zugewiesener Ansprechpartner, Ersteller, Gesundheitswert und Plan.

Client abrufen

get/api/v1/clients/{id}
clients:read
Query-Parameter
idstringerforderlich
Der abzurufende Kunde.
Antwort
dataobjectoptional
Alles aus Client, plus die aufgelösten Objekte für Ansprechpartner, Ersteller und Plan.
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.
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/clients/{id}
Ihr API-Schlüssel
id *
{
  "data": {
    "id": "cli_123",
    "businessName": "Acme Dental",
    "website": "https://acmedental.com",
    "industry": "Dental",
    "primaryContactEmail": "owner@acmedental.com",
    "primaryRepresentativeId": "usr_123",
    "visibility": "public",
    "goal": "get_reviews",
    "notes": null,
    "gbpLink": null,
    "trackingKeyword": "dentist near me",
    "healthScore": 82,
    "planName": null,
    "archived": false,
    "archivedAt": null,
    "scheduledArchiveAt": null,
    "createdAt": "2026-01-15T10:00:00.000Z",
    "updatedAt": "2026-01-15T10:00:00.000Z",
    "primaryRepresentative": {
      "id": "usr_123",
      "firstName": "Jamie",
      "lastName": "Lee",
      "email": "jamie@youragency.com"
    },
    "createdBy": {
      "id": "usr_123",
      "firstName": "Jamie",
      "lastName": "Lee",
      "email": "jamie@youragency.com"
    },
    "clientPlan": null
  }
}
v1Ressourcen/Clients/patchClient aktualisieren

Bearbeitet die editierbaren Felder eines bestehenden Kunden. Übergeben Sie nur die Felder, die Sie ändern möchten. Die primaryContactEmail des Kunden (der Portal-Login) kann hier nur gesetzt werden, solange sie noch leer ist — sie kann nach dem Setzen nie mehr geändert werden.

Client aktualisieren

patch/api/v1/clients/{id}
clients:write
Query-Parameter
idstringerforderlich
Der zu aktualisierende Kunde.
Anfragetext
businessNamestringoptional
Der Firmenname für den neuen Kunden.
industrystringoptional
Die Branche des Kunden.
websitestringoptional
Die Website-URL des Kunden.
primaryContactNamestringoptional
Der Name der primären Kontaktperson.
phonestringoptional
Die Telefonnummer des Kunden.
locationCountnumberoptional
Die vom Kunden angegebene Standortanzahl — nur informativ, nicht die tatsächliche Anzahl erstellter Standorte.
citystringoptional
Die Stadt des Kunden.
phoneCountryCodestringoptional
Das ISO-3166-1-Alpha-2-Land, zu dem die Telefonnummer des Kunden gehört (z. B. "US", "IN") — die Region, nicht die Vorwahl.
countrystringoptional
Das Land des Kunden, als ISO-3166-1-Alpha-2-Code.
statestringoptional
Das Bundesland, die Provinz oder die Region des Kunden.
trackingKeywordstringoptional
Ein Schlüsselwort, um das lokale Suchranking des Kunden zu verfolgen.
notesstringoptional
Eine interne Notiz zum Kunden — nur für Ihr Team sichtbar, niemals für den Kunden.
gbpLinkstringoptional
Die Google-Unternehmensprofil-URL des Kunden.
packageTypestringoptional
Der Pakettyp des Kunden.
clientPlanIdstringoptional
Welcher Kundenportal-Plan zugewiesen werden soll. Standardmäßig der Standardplan Ihrer Agentur. Es gibt keinen Endpunkt, der Pläne auflistet — entnehmen Sie eine gültige ID aus der clientPlan.id eines bestehenden Kunden oder aus den Plan-Einstellungen Ihrer Agentur in Synup.
primaryRepresentativeIdstringoptional
Die Benutzer-ID des Teammitglieds, dem dieser Kunde gehört — siehe GET /api/v1/team/members für die Mitglieds-IDs Ihrer Agentur.
visibilitystring (public | private)optional
Ob der Kunde innerhalb Ihrer Agentur public oder private ist.
primaryContactEmailstringoptional
E-Mail-Adresse der primären Kontaktperson des Kunden. Nur setzbar, solange sie noch leer ist — sie wird der Portal-Login und kann nach dem Setzen nie mehr geändert werden.
Antwort
dataobjectoptional
Es können weitere interne Felder vorhanden sein, die nicht Teil des stabilen Vertrags sind — verlassen Sie sich nur auf die hier dokumentierten Felder.
idstringoptional
Eindeutige Kennung des Kunden.
businessNamestringoptional
Der Firmenname des Kunden.
websitestringoptional
Die Website-URL des Kunden.
industrystringoptional
Die Branche des Kunden.
primaryContactEmailstringoptional
E-Mail-Adresse der primären Kontaktperson des Kunden.
primaryRepresentativeIdstringoptional
ID des Teammitglieds, das für diesen Kunden verantwortlich ist — siehe GET /api/v1/team/members für die Mitglieds-IDs Ihrer Agentur.
visibilitystring (public | private)optional
Ob der Kunde innerhalb Ihrer Agentur public oder private ist.
goalstring (improve_rankings | get_reviews | fix_listings)optional
Das primäre Ziel des Kunden, oder null.
notesstringoptional
Eine interne Notiz zum Kunden — nur für Ihr Team sichtbar, niemals für den Kunden.
gbpLinkstringoptional
Die Google-Unternehmensprofil-URL des Kunden, oder null.
trackingKeywordstringoptional
Ein für das lokale Suchranking dieses Kunden verfolgtes Schlüsselwort, oder null.
healthScorenumberoptional
Ein Wert von 0–100, der den Kontostatus des Kunden zusammenfasst, oder null, falls noch nicht berechnet.
planNamestringoptional
Name des Plans, auf dem dieser Kunde läuft, falls vorhanden.
archivedbooleanoptional
Ob der Kunde archiviert ist.
archivedAtstringoptional
Zeitpunkt der Archivierung des Kunden, als ISO-8601-Zeitstempel, oder null.
scheduledArchiveAtstringoptional
Zeitpunkt, zu dem die Archivierung angefordert wurde (zugleich das Kohorten-Token, um sie abzubrechen), als ISO-8601-Zeitstempel, oder null, wenn keine ausstehend ist.
createdAtstringoptional
Zeitpunkt der Erstellung des Kunden, als ISO-8601-Zeitstempel.
updatedAtstringoptional
Zeitpunkt der letzten Aktualisierung des Kunden, 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.
patch/api/v1/clients/{id}
Ihr API-Schlüssel
id *
Anfragetext
{
  "data": {
    "id": "cli_123",
    "businessName": "Acme Dental",
    "website": "https://acmedental.com",
    "industry": "Dental",
    "primaryContactEmail": "owner@acmedental.com",
    "primaryRepresentativeId": "usr_123",
    "visibility": "public",
    "goal": "get_reviews",
    "notes": null,
    "gbpLink": null,
    "trackingKeyword": "dentist near me",
    "healthScore": 82,
    "planName": null,
    "archived": false,
    "archivedAt": null,
    "scheduledArchiveAt": null,
    "createdAt": "2026-01-15T10:00:00.000Z",
    "updatedAt": "2026-02-01T09:30:00.000Z"
  }
}
v1Ressourcen/Clients/deleteClient archivieren

Fordert die Archivierung eines Kunden an — diese API löscht einen Kunden niemals endgültig. Hat der Kunde Standorte, wird dies GEPLANT: Kunde und alle seine Standorte archivieren am Ende des aktuellen Abrechnungszeitraums, bis dahin bleibt alles vollständig aktiv und wird abgerechnet — die Archivierung kann über den cancel-archive-Endpunkt zurückgenommen werden. Ein Kunde ganz ohne Standorte wird stattdessen sofort archiviert (es gibt nichts aufzuschieben). Das outcome-Feld der Antwort zeigt, welcher der beiden Fälle tatsächlich eingetreten ist.

Client archivieren

delete/api/v1/clients/{id}
clients:write
Query-Parameter
idstringerforderlich
Der zu archivierende Kunde.
Antwort
dataobjectoptional
Welche Felder vorhanden sind, hängt von outcome ab: scheduled enthält scheduledArchiveAt/archiveAt/locationCount; archived enthält locationsArchived/locationsFailed/cancelledScheduledPosts.
outcomestring (scheduled | archived)erforderlich
Was tatsächlich passiert ist: archived (sofort — es gab keine Standorte, oder keiner war aktiv) oder scheduled (archiviert am Ende des Abrechnungszeitraums).
clientIdstringerforderlich
Eindeutige Kennung des Kunden.
businessNamestringerforderlich
Der Firmenname des Kunden.
scheduledArchiveAtstringoptional
Zeitpunkt, zu dem die Archivierung angefordert wurde (zugleich das Kohorten-Token, um sie abzubrechen), als ISO-8601-Zeitstempel, oder null, wenn keine ausstehend ist.
archiveAtstringoptional
Wann die geplante Archivierung tatsächlich eintritt — die Abrechnungsgrenze der Agentur. Null, wenn die Agentur keine hat. Nur vorhanden, wenn outcome scheduled ist.
locationCountnumberoptional
Anzahl der Standorte dieses Kunden, oder null, falls unbekannt.
locationsArchivednumberoptional
Anzahl der zusammen mit dem Kunden archivierten Standorte. Nur vorhanden, wenn outcome archived ist.
locationsFailednumberoptional
Anzahl der Standorte, deren Archivierung fehlgeschlagen ist. Nur vorhanden, wenn outcome archived ist.
cancelledScheduledPostsnumberoptional
Anzahl der im Rahmen der Archivierung abgebrochenen geplanten Beiträge. Nur vorhanden, wenn outcome archived ist.
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.
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.
delete/api/v1/clients/{id}
Ihr API-Schlüssel
id *
{
  "data": {
    "outcome": "scheduled",
    "clientId": "cli_123",
    "businessName": "Acme Dental",
    "scheduledArchiveAt": "2026-02-01T00:00:00.000Z",
    "archiveAt": "2026-03-01T00:00:00.000Z",
    "locationCount": 1
  }
}
v1Ressourcen/Clients/postGeplante Archivierung abbrechen

Bricht eine ausstehende Kundenarchivierung ab, sodass ein zur Archivierung am Ende des Abrechnungszeitraums geplanter Kunde normal weiterläuft. Gibt auch die zusammen damit geplanten Standorte wieder frei. Funktioniert nur, solange die Archivierung noch ausstehend ist — ein bereits vollständig archivierter Kunde muss stattdessen über den reactivate-Endpunkt wiederhergestellt werden.

Geplante Archivierung abbrechen

post/api/v1/clients/{id}/cancel-archive
clients:write
Query-Parameter
idstringerforderlich
Der Kunde, dessen ausstehende Archivierung abgebrochen werden soll.
Antwort
dataobjectoptional
cancelledbooleanoptional
Bei Erfolg immer true.
locationsReleasednumberoptional
Anzahl der aus dem abgebrochenen Archivierungsplan freigegebenen Standorte.
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.
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/clients/{id}/cancel-archive
Ihr API-Schlüssel
id *
{
  "data": {
    "cancelled": true,
    "locationsReleased": 1
  }
}
v1Ressourcen/Clients/postPortal-Einladung senden

Sendet (oder sendet erneut) die Kundenportal-Einladungs-E-Mail an den primären Ansprechpartner eines Kunden — einen passwortlosen Magic-Link. Erneutes Senden macht zuvor gesendete Links ungültig. Schlägt fehl, wenn für den Kunden keine primaryContactEmail gesetzt ist.

Portal-Einladung senden

post/api/v1/clients/{id}/invite
clients:write
Query-Parameter
idstringerforderlich
Der einzuladende Kunde.
Antwort
dataobjectoptional
portalLinkstringoptional
Die in der Einladungs-E-Mail gesendete Magic-Link-URL.
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.
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/clients/{id}/invite
Ihr API-Schlüssel
id *
{
  "data": {
    "portalLink": "https://portal.synup.com/invite/aB3dE9fGhJ"
  }
}
v1Ressourcen/Clients/postArchivierten Client reaktivieren

Stellt einen bereits archivierten Kunden wieder her, samt jedem Standort, der zusammen mit ihm archiviert wurde. Ist ein Kunde derzeit nicht archiviert, gilt der Aufruf als erfolgreicher No-op, nicht als Fehler. Dies ist der einzige Weg zurück für einen Kunden mit outcome archived — einer, der noch geplant ist, sollte stattdessen über cancel-archive laufen.

Archivierten Client reaktivieren

post/api/v1/clients/{id}/reactivate
clients:write
Query-Parameter
idstringerforderlich
Der zu reaktivierende Kunde.
Antwort
dataobjectoptional
archivedbooleanoptional
Ob der Kunde archiviert ist.
locationsArchivednumberoptional
Anzahl der zusammen mit dem Kunden archivierten Standorte. Nur vorhanden, wenn outcome archived ist.
locationsFailednumberoptional
Anzahl der Standorte, deren Archivierung fehlgeschlagen ist. Nur vorhanden, wenn outcome archived ist.
cancelledScheduledPostsnumberoptional
Anzahl der im Rahmen der Archivierung abgebrochenen geplanten Beiträge. Nur vorhanden, wenn outcome archived ist.
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.
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/clients/{id}/reactivate
Ihr API-Schlüssel
id *
{
  "data": {
    "archived": false,
    "locationsArchived": 1,
    "locationsFailed": 0,
    "cancelledScheduledPosts": 0
  }
}
v1Ressourcen/Clients/getKundenzusammenfassung abrufen

Liefert eine zusammengefasste Momentaufnahme für einen Kunden: aggregierte Standort-, Bewertungs- und SEO-Statistiken.

Kundenzusammenfassung abrufen

get/api/v1/clients/summary
clients:read
Query-Parameter
clientIdstringerforderlich
Der zusammenzufassende Kunde.
Antwort
dataobjectoptional
locationsobjectoptional
Aggregierte Standortstatistiken für diesen Kunden.
reviewsobjectoptional
Aggregierte Bewertungsstatistiken für diesen Kunden.
seoobjectoptional
Aggregierte SEO-Ranking-Statistiken für diesen Kunden.
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/clients/summary
Ihr API-Schlüssel
clientId *
{
  "data": {
    "locations": {
      "total": 1,
      "byStatus": {
        "approved": 1
      },
      "byVerification": {
        "unknown": 1
      }
    },
    "reviews": {
      "avgRating": 4.8,
      "total": 26
    },
    "seo": {
      "avgRank": 3.2,
      "top3Pct": 0.62
    }
  }
}