v1Ressourcen/Clients/postBenutzer zum Kundenportal hinzufügen

Benutzer zum Kundenportal hinzufügen

Gespeicherte Portalbenutzer lesen, ohne alte Kontaktbenutzer anzulegen. Per E-Mail hinzufügen; sendInvite ist standardmäßig true. Ein Versandfehler lässt den Benutzer bestehen. Änderungen erlauben nur Aktivieren, Deaktivieren oder Eigentumsübertragung mit makePrimary=true. Entfernen lässt offene Anmeldelinks ablaufen; ein Inhaber mit weiteren Benutzern kann nicht entfernt werden. Widerruf löscht nur eingeladene Benutzer ohne erste Anmeldung und beendet alle offenen Links.

post/api/v1/clients/{id}/users
clients:write
Query-Parameter
idstringerforderlich
Anfragetext
emailstringerforderlich
firstNamestringoptional
lastNamestringoptional
sendInvitebooleanoptional
Antwort
dataobjecterforderlich
userobjectoptional
idstringoptional
emailstringoptional
firstNamestringoptional
lastNamestringoptional
statusstringoptional
isPrimarybooleanoptional
rolestring (owner | member)optional
invitedAtstringoptional
lastLoginAtstringoptional
inviteSentAtstringoptional
inviteobjectoptional
sentbooleanoptional
portalLinkstringoptional
reasonstring (portal_domain_required | send_failed)optional
errorstringoptional
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}/users
Ihr API-Schlüssel
id *
Anfragetext*
{}

Anleitungen, die diese Ressource verwenden