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

Portal-Einladung senden

Einladung an den Hauptkontakt senden oder erneut senden. clientUserId adressiert einen nicht deaktivierten Benutzer vor seiner ersten Anmeldung. Ohne Inhalt bleibt das Hauptkontaktverhalten erhalten; ungültiges JSON wird abgewiesen. Gibt portalLink zurück. Frühere Links bleiben bis zur Nutzung oder ihrem Ablauf nach sieben Tagen gültig. Der identifizierte Schlüsselinhaber benötigt Zugriff auf diesen Kunden.

post/api/v1/clients/{id}/invite
clients:write
Query-Parameter
idstringerforderlich
Der einzuladende Kunde.
Anfragetext
clientUserIdstringoptional
Antwort
dataobjectoptional
portalLinkstringoptional
Die in der Einladungs-E-Mail gesendete Magic-Link-URL.
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.
503Der Dienst ist vorübergehend nicht verfügbar. Wiederholen Sie eine Gutschrift mit demselben Idempotenzschlüssel.
post/api/v1/clients/{id}/invite
Ihr API-Schlüssel
id *
Anfragetext
{
  "data": {
    "portalLink": "https://portal.synup.com/invite/aB3dE9fGhJ"
  }
}

Anleitungen, die diesen Endpunkt verwenden