Zum Hauptinhalt springen
POST
Erstellen Sie ein neues Profil unter Ihrem Primary Profile. Nach erfolgreicher Erstellung des User Profiles enthält die API-Antwort den Profile Key, der dem neu erstellten Profil zugeordnet ist. Speichern Sie den Profile Key sicher in Ihrem System, da er für API-Aufrufe im Namen Ihres Nutzers benötigt wird. Bitte beachten Sie, dass Profile Keys aus Sicherheitsgründen nur in zwei bestimmten Fällen zurückgegeben werden:
  1. Erstellung eines User Profiles: Wenn ein neues User Profile erstellt wird.
  2. Im Ayrshare-Dashboard: Sie finden den Profile Key für jedes Profil im Ayrshare-Dashboard. Wechseln Sie zum User Profile und navigieren Sie dann zur Seite Profile Key.
Wir empfehlen, den Profile Key sicher in Ihrem System zu speichern.

Soziale Netzwerke verwalten

Verwenden Sie das Feld disableSocial, um soziale Netzwerke aus der Anzeige zu verwalten (hinzufügen/entfernen). Weitere Informationen finden Sie unter Social-Media-Konten verwalten.

Aktive User Profiles verwalten

Empfehlungen zur Verwaltung aktiver User Profiles finden Sie hier.

Wichtige Sicherheitshinweise

  • Vermeiden Sie es, Profile Keys öffentlich zu teilen oder sie in clientseitigem Code oder öffentlichen Repositories preiszugeben.
  • Profile Keys sind sensible Anmeldedaten, die zur Authentifizierung und Autorisierung des Zugriffs auf User Profiles verwendet werden.
  • Es ist entscheidend, Profile Keys sicher in Ihrem System zu speichern und mit geeigneten Zugriffskontrollen zu versehen, um die Integrität und Vertraulichkeit der Nutzerdaten zu gewährleisten.
  • Aus Sicherheitsgründen kann der Profile Key nicht erneut über die API abgerufen werden. Sie können den Profile Key jedoch über das Dashboard abrufen.
  • Die refId sollte ebenfalls gespeichert werden, um ein Profil einer Endpunkt-Rückgabe zuzuordnen.

Header-Parameter

Body-Parameter

title
string
erforderlich
Titel des neuen Profils. Muss eindeutig sein. Dieser Titel wird auf der Seite zur Verknüpfung von Social-Media-Konten angezeigt.
messagingActive
boolean
Standard:false
Auf „true“ setzen, um Messaging für dieses User Profile zu aktivieren. Messaging muss zuvor für Ihr Ayrshare-Konto aktiviert sein.
hideTopHeader
boolean
Standard:false
Blendet die obere Kopfzeile auf der Seite zur Verknüpfung von Social-Media-Konten aus.
Blendet das Firmenlogo auf der Seite zur Verknüpfung von Social-Media-Konten nur für dieses User Profile aus. Das kontoweite Logo auf anderen Profilen bleibt unberührt. Nützlich, um einzelne Partnerprofile mit White-Labeling zu versehen und gleichzeitig das Branding auf den übrigen Profilen zu behalten.
topHeader
string
Ändert die Kopfzeile auf der Seite zur Verknüpfung von Social-Media-Konten. Wenn nicht gesetzt, wird angezeigt: „Social Accounts for ‚title‘“, wobei „title“ der Profiltitel ist.
disableSocial
array
Array sozialer Netzwerke, die für das Profil dieses Nutzers deaktiviert sind. Die Liste der deaktivierten sozialen Netzwerke des Primary Profiles hat Vorrang.Verfügbare Netzwerke: bluesky, facebook, gmb, instagram, linkedin, pinterest, reddit, snapchat, telegram, threads, tiktok, twitter und youtube.Weitere Informationen finden Sie unter Soziale Netzwerke aktivieren oder deaktivieren.
team
boolean
Standard:false
Erstellen Sie ein neues User Profile als Teammitglied, indem Sie team: true setzen. Das Feld email wird verwendet, um eine Einladungs-E-Mail zu versenden. Details zu den Anforderungen finden Sie unter Ein Teammitglied einladen.
email
string
Eine gültige E-Mail-Adresse, an die die Einladung des Teammitglieds gesendet wird. Erforderlich, wenn team: true.
subHeader
string
Ändert die Unterüberschrift auf der Seite zur Verknüpfung von Social-Media-Konten. Aktuell wird „Click an icon to link a social network“ angezeigt. Auf einen leeren String setzen, um sie zu entfernen.Erfahren Sie, wie Sie den Hilfelink ändern.
tags
array
Versehen Sie User Profiles mit Tags in Form eines String-Arrays. Diese Tags dienen als internes Organisationswerkzeug, um Ihre User Profiles effektiv zu kategorisieren und zu verwalten.