v1Ressourcen/Clients/postClient erstellen
Client erstellen
Erstellt einen neuen Kunden in Ihrer Agentur sowie einen ersten Standort, sobald sich die Adressangaben einem echten Ort zuordnen lassen.
post
clients:write/api/v1/clientsAnfragetext
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
}
}