Zum Hauptinhalt springen

Workspaces

Der Workspace-Service verwaltet Workspaces, Teammitglieder, Einladungen, Abonnements und Abrechnung.

Konzepte

Workspaces

Ein Workspace ist die oberste Organisationseinheit. Alle Ressourcen (Brand Voices, Zielgruppen, Konversationen) gehoeren zu einem Workspace.

Mitglieder & Rollen

Jedes Workspace-Mitglied hat eine von drei Rollen:

RolleBeschreibung
OWNERVolle Kontrolle, kann Abrechnung verwalten und Workspace loeschen
ADMINKann Mitglieder und die meisten Einstellungen verwalten
MEMBERKann Funktionen innerhalb des Workspaces nutzen

Einladungen

Mitglieder werden ueber E-Mail-Einladungen mit Bestaetigungscodes hinzugefuegt. Einladungen koennen angenommen, abgelehnt, storniert oder erneut gesendet werden.

Endpoints

Base Path: https://app.neuroflash.com/api/workspace-service

Workspaces

MethodeEndpointBeschreibung
POST/v1/workspacesWorkspace erstellen
GET/v1/workspacesIhre Workspaces auflisten
GET/v1/workspaces/{id}Workspace abrufen
PUT/v1/workspaces/{id}Workspace aktualisieren
DELETE/v1/workspaces/{id}Workspace loeschen

Mitglieder

MethodeEndpointBeschreibung
GET/v1/workspaces/{id}/workspace-membersMitglieder auflisten
GET/v1/workspaces/{id}/workspace-members/{memberId}Mitglied abrufen
PUT/v1/workspaces/{id}/workspace-members/{memberId}Mitgliederrolle aktualisieren
DELETE/v1/workspaces/{id}/workspace-members/{memberId}Mitglied entfernen

Einladungen

MethodeEndpointBeschreibung
POST/v1/workspaces/{id}/invitesEinladung erstellen
GET/v1/workspaces/{id}/invitesEinladungen auflisten
DELETE/v1/workspaces/{id}/invites/{inviteId}Einladung stornieren

Abonnements & Abrechnung

MethodeEndpointBeschreibung
GET/v1/workspaces/{id}/current-subscriptionAktuelles Abonnement abrufen
GET/v1/workspaces/{id}/billing-contactRechnungskontakt abrufen
PUT/v1/workspaces/{id}/billing-contactRechnungskontakt aktualisieren
POST/v1/workspaces/{id}/stripe-sessionsStripe-Abrechnungsportal-URL abrufen