Synupv1
Schlüssel erstellen
v1Ressourcen/Team

Team

Verwalten des Team-Verzeichnisses Ihrer Agentur — Mitglieder auflisten, neue einladen, deren Kapazität, Berechtigungen oder verknüpften Slack-Nutzer aktualisieren sowie Einladungen erneut senden oder widerrufen. Hinweis: Um einen API-Schlüssel mit team:write auszustellen, muss die Person, die den Schlüssel erstellt, bereits Inhaber, Administrator oder Mitarbeiter von Synup sein. Diese Prüfung erfolgt einmalig, in den Einstellungen, bei der Erstellung des Schlüssels — nicht bei jeder einzelnen Anfrage. Wird Ihr Versuch, einen team:write-Schlüssel zu erstellen, also abgelehnt, liegt es daran, auch wenn die unten dokumentierten REST-Aufrufe diese Prüfung selbst nie erneut durchführen.

Liefert das Team-Verzeichnis Ihrer Agentur — jeden Nutzer in Ihrer Agentur außer dem agenturweiten Synup Bot.

Teammitglieder auflisten

get/api/v1/team/members
team:read
Antwort
dataarray of objectoptional
idstringoptional
Eindeutige Kennung des Teammitglieds.
firstNamestringoptional
Der Vorname des Teammitglieds.
lastNamestringoptional
Der Nachname des Teammitglieds.
emailstringoptional
Die E-Mail-Adresse des Teammitglieds.
rolestringoptional
Die Rolle des Teammitglieds, z. B. "owner" oder "member".
invitationStatusstringoptional
Der Einladungsstatus des Mitglieds: "invited", "accepted", oder null bei einem Mitglied, das den Einladungsprozess nie durchlaufen hat.
lastSessionAtstringoptional
Wann das Mitglied zuletzt eine aktive Sitzung hatte, als ISO-8601-Zeitstempel, oder null, falls nie.
createdAtstringoptional
Wann das Teammitglied erstellt wurde, als ISO-8601-Zeitstempel.
weeklyHoursCapacitynumberoptional
Die wöchentliche Arbeitsstundenkapazität des Mitglieds, oder null, falls nicht gesetzt.
permissionsobjectoptional
Berechtigungsflags je Modul (dashboard, clients, listings usw.), oder null, falls nie gesetzt.
slackUserIdstringoptional
Die mit diesem Mitglied verknüpfte Slack-Nutzer-ID, oder null, falls keine.
statusstring (Owner | Invited | Active | Not Active)optional
Eine berechnete Zusammenfassung des Zustands des Mitglieds: "Owner", "Invited", "Active" oder "Not Active" (akzeptiert, aber in den letzten 7 Tagen keine Sitzung).
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.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
get/api/v1/team/members
Ihr API-Schlüssel
{}
v1Ressourcen/Team/postTeammitglied einladen

Lädt ein neues Teammitglied per E-Mail ein. Das eingeladene Mitglied wird immer mit der Rolle "member" erstellt und, sofern keine permissions angegeben werden, mit der Standard-Berechtigungsvorlage für Mitglieder — ein API-Schlüssel kann niemals jemanden als owner oder admin einladen.

Teammitglied einladen

post/api/v1/team/members
team:write
Anfragetext
firstNamestringerforderlich
Der Vorname des neuen Teammitglieds.
lastNamestringerforderlich
Der Nachname des neuen Teammitglieds.
emailstringerforderlich
Die E-Mail-Adresse des neuen Teammitglieds.
permissionsobjectoptional
Zu gewährende Berechtigungsflags je Modul. Optional; wenn weggelassen (oder leer), wird die Standard-Berechtigungsvorlage für Mitglieder verwendet.
Antwort
dataobjectoptional
userIdstringoptional
ID des neu eingeladenen Teammitglieds.
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.
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).
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/team/members
Ihr API-Schlüssel
Anfragetext*
{}
v1Ressourcen/Team/patchTeammitglied aktualisieren

Aktualisiert die wöchentliche Stundenkapazität, die Modulberechtigungen oder den verknüpften Slack-Nutzer eines Teammitglieds. Mindestens ein Feld muss angegeben werden. Dies kann die Rolle eines Mitglieds nicht ändern.

Teammitglied aktualisieren

patch/api/v1/team/members
team:write
Anfragetext
memberIdstringerforderlich
ID des Teammitglieds.
weeklyHoursCapacitynumberoptional
Neue wöchentliche Arbeitsstundenkapazität, zwischen 0 und 80.
permissionsobjectoptional
Zu gewährende Berechtigungsflags je Modul. Optional; wenn weggelassen (oder leer), wird die Standard-Berechtigungsvorlage für Mitglieder verwendet.
slackUserIdstringoptional
Mit diesem Mitglied zu verknüpfende Slack-Nutzer-ID, oder null, um die Verknüpfung aufzuheben. Das Verknüpfen einer bereits von einem anderen Mitglied verwendeten Slack-ID hebt deren Verknüpfung bei diesem anderen Mitglied auf.
Antwort
dataobjectoptional
memberobjectoptional
Die durch dieses Update tatsächlich geänderten Felder — nicht das vollständige Profil des Mitglieds. Rufen Sie GET /api/v1/team/members auf, um den vollständigen Datensatz zu sehen.
idstringoptional
Eindeutige Kennung des Teammitglieds.
weeklyHoursCapacitynumberoptional
Die wöchentliche Arbeitsstundenkapazität des Mitglieds, oder null, falls nicht gesetzt.
permissionsobjectoptional
Berechtigungsflags je Modul (dashboard, clients, listings usw.), oder null, falls nie gesetzt.
slackUserIdstringoptional
Die mit diesem Mitglied verknüpfte Slack-Nutzer-ID, oder null, falls keine.
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.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
patch/api/v1/team/members
Ihr API-Schlüssel
Anfragetext*
{}
v1Ressourcen/Team/deleteTeammitglied entfernen

Entfernt ein Teammitglied aus der Agentur. Der Agentur-Inhaber kann nicht entfernt werden.

Teammitglied entfernen

delete/api/v1/team/members
team:write
Query-Parameter
memberIdstringerforderlich
ID des zu entfernenden Teammitglieds.
Antwort
dataobjectoptional
removedbooleanoptional
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.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
delete/api/v1/team/members
Ihr API-Schlüssel
memberId *
{}
v1Ressourcen/Team/postTeam-Einladung erneut senden

Generiert einen neuen Einladungslink und sendet die Einladungs-E-Mail erneut an ein Teammitglied, das noch nicht akzeptiert hat.

Team-Einladung erneut senden

post/api/v1/team/members/resend-invite
team:write
Anfragetext
memberIdstringerforderlich
ID des Teammitglieds.
Antwort
dataobjectoptional
resentbooleanoptional
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.
post/api/v1/team/members/resend-invite
Ihr API-Schlüssel
Anfragetext*
{}
v1Ressourcen/Team/postZugriff eines Teammitglieds widerrufen

Entfernt ein Teammitglied, das seine Einladung bereits akzeptiert hat. Der Agentur-Inhaber kann nicht widerrufen werden, und ein Mitglied, das seine Einladung noch nicht akzeptiert hat, sollte stattdessen mit DELETE /api/v1/team/members entfernt werden.

Zugriff eines Teammitglieds widerrufen

post/api/v1/team/members/revoke
team:write
Anfragetext
memberIdstringerforderlich
ID des Teammitglieds.
Antwort
dataobjectoptional
revokedbooleanoptional
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.
post/api/v1/team/members/revoke
Ihr API-Schlüssel
Anfragetext*
{}