Synupv1
Schlüssel erstellen
v1Ressourcen/Clients/patchClient aktualisieren

Client 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.

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"
  }
}