Synup
Schlüssel erstellen
v1Ressourcen/Clients/postPortal-Einladung senden

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

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

Anleitungen, die diesen Endpunkt verwenden