v1Ressources/Équipe
Équipe
Gérez l'effectif de votre agence — listez les membres, invitez-en de nouveaux, mettez à jour leur capacité, leurs permissions ou leur utilisateur Slack associé, et renvoyez ou révoquez des invitations. Remarque : émettre une clé API avec team:write nécessite que la personne créant la clé soit déjà owner, admin ou membre du personnel Synup. Cette vérification a lieu une seule fois, dans Paramètres, à la création de la clé — pas à chaque requête individuelle — donc si votre tentative de création d'une clé team:write est refusée, c'est la raison, même si les appels REST documentés ci-dessous ne la revérifient jamais eux-mêmes.
Renvoie l'effectif de votre agence — tous les utilisateurs de votre agence sauf le Synup Bot propre à chaque agence.
Lister les membres de l'équipe
get
team:read/api/v1/team/membersRéponse
dataarray of objectfacultatif
idstringfacultatif
Identifiant unique du membre de l'équipe.
firstNamestringfacultatif
Le prénom du membre de l'équipe.
lastNamestringfacultatif
Le nom de famille du membre de l'équipe.
emailstringfacultatif
L'adresse e-mail du membre de l'équipe.
rolestringfacultatif
Le rôle du membre de l'équipe, par ex. "owner" ou "member".
invitationStatusstringfacultatif
L'état d'invitation du membre : "invited", "accepted", ou null pour un membre qui n'est jamais passé par le flux d'invitation.
lastSessionAtstringfacultatif
Date de la dernière session active du membre, au format horodatage ISO 8601, ou null si jamais.
createdAtstringfacultatif
Date de création du membre de l'équipe, au format horodatage ISO 8601.
weeklyHoursCapacitynumberfacultatif
La capacité en heures de travail hebdomadaires du membre, ou null si non définie.
permissionsobjectfacultatif
Indicateurs d'accès par module (dashboard, clients, listings, etc.), ou null si jamais définis.
slackUserIdstringfacultatif
L'ID d'utilisateur Slack associé à ce membre, ou null si aucun.
statusstring (Owner | Invited | Active | Not Active)facultatif
Un résumé calculé de l'état du membre : "Owner", "Invited", "Active", ou "Not Active" (accepté mais aucune session dans les 7 derniers jours).
Erreurs
401Clé API manquante, invalide, expirée ou révoquée.
403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
get/api/v1/team/members
Votre clé API
{}v1Ressources/Équipe/postInviter un membre de l'équipe
Invite un nouveau membre de l'équipe par e-mail. Le membre invité est toujours créé avec le rôle "member" et, sauf si des permissions sont fournies, le préréglage de permissions par défaut pour member — une clé API ne peut jamais inviter quelqu'un en tant que owner ou admin.
Inviter un membre de l'équipe
post
team:write/api/v1/team/membersCorps de la requête
firstNamestringobligatoire
Le prénom du nouveau membre de l'équipe.
lastNamestringobligatoire
Le nom de famille du nouveau membre de l'équipe.
emailstringobligatoire
L'adresse e-mail du nouveau membre de l'équipe.
permissionsobjectfacultatif
Indicateurs d'accès par module à accorder. Facultatif ; quand omis (ou vide), le préréglage de permissions par défaut pour member est utilisé.
Réponse
dataobjectfacultatif
userIdstringfacultatif
ID du membre de l'équipe nouvellement invité.
Erreurs
400Il manque un paramètre requis à la requête, ou elle est invalide.
401Clé API manquante, invalide, expirée ou révoquée.
403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.
409La requête entre en conflit avec l'état actuel de la ressource — par exemple, modifier l'e-mail ou le téléphone d'un destinataire à qui un message a déjà été envoyé, ou une invitation d'équipe déjà acceptée (ou pas encore acceptée).
422Il manque un paramètre requis à la requête, ou elle est invalide.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
post/api/v1/team/members
Votre clé API
Corps de la requête*
{}v1Ressources/Équipe/patchMettre à jour un membre de l'équipe
Met à jour la capacité en heures hebdomadaires, les permissions de module ou l'utilisateur Slack associé d'un membre de l'équipe. Au moins un champ doit être fourni. Ceci ne peut pas changer le rôle d'un membre.
Mettre à jour un membre de l'équipe
patch
team:write/api/v1/team/membersCorps de la requête
memberIdstringobligatoire
ID du membre de l'équipe.
weeklyHoursCapacitynumberfacultatif
Nouvelle capacité en heures de travail hebdomadaires, entre 0 et 80.
permissionsobjectfacultatif
Indicateurs d'accès par module à accorder. Facultatif ; quand omis (ou vide), le préréglage de permissions par défaut pour member est utilisé.
slackUserIdstringfacultatif
ID d'utilisateur Slack à associer à ce membre, ou null pour le dissocier. Associer un ID Slack déjà utilisé par un autre membre le dissocie de cet autre membre.
Réponse
dataobjectfacultatif
memberobjectfacultatif
Les champs réellement modifiés par cette mise à jour — pas le profil complet du membre. Consultez GET /api/v1/team/members pour voir l'enregistrement complet.
idstringfacultatif
Identifiant unique du membre de l'équipe.
weeklyHoursCapacitynumberfacultatif
La capacité en heures de travail hebdomadaires du membre, ou null si non définie.
permissionsobjectfacultatif
Indicateurs d'accès par module (dashboard, clients, listings, etc.), ou null si jamais définis.
slackUserIdstringfacultatif
L'ID d'utilisateur Slack associé à ce membre, ou null si aucun.
Erreurs
400Il manque un paramètre requis à la requête, ou elle est invalide.
401Clé API manquante, invalide, expirée ou révoquée.
403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.
404La ressource est introuvable, ou n'appartient pas à votre agence.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
patch/api/v1/team/members
Votre clé API
Corps de la requête*
{}v1Ressources/Équipe/deleteRetirer un membre de l'équipe
Retire un membre de l'équipe de l'agence. Le propriétaire de l'agence ne peut pas être retiré.
Retirer un membre de l'équipe
delete
team:write/api/v1/team/membersParamètres de requête
memberIdstringobligatoire
ID du membre de l'équipe à retirer.
Réponse
dataobjectfacultatif
removedbooleanfacultatif
Erreurs
400Il manque un paramètre requis à la requête, ou elle est invalide.
401Clé API manquante, invalide, expirée ou révoquée.
403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.
404La ressource est introuvable, ou n'appartient pas à votre agence.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
delete/api/v1/team/members
Votre clé API
memberId *
{}v1Ressources/Équipe/postRenvoyer une invitation d'équipe
Génère un nouveau lien d'invitation et renvoie l'e-mail d'invitation à un membre de l'équipe qui n'a pas encore accepté.
Renvoyer une invitation d'équipe
post
team:write/api/v1/team/members/resend-inviteCorps de la requête
memberIdstringobligatoire
ID du membre de l'équipe.
Réponse
dataobjectfacultatif
resentbooleanfacultatif
Erreurs
400Il manque un paramètre requis à la requête, ou elle est invalide.
401Clé API manquante, invalide, expirée ou révoquée.
403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.
404La ressource est introuvable, ou n'appartient pas à votre agence.
409La requête entre en conflit avec l'état actuel de la ressource — par exemple, modifier l'e-mail ou le téléphone d'un destinataire à qui un message a déjà été envoyé, ou une invitation d'équipe déjà acceptée (ou pas encore acceptée).
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
post/api/v1/team/members/resend-invite
Votre clé API
Corps de la requête*
{}v1Ressources/Équipe/postRévoquer l'accès d'un membre de l'équipe
Retire un membre de l'équipe ayant déjà accepté son invitation. Le propriétaire de l'agence ne peut pas être révoqué, et un membre qui n'a pas encore accepté son invitation doit plutôt être retiré avec DELETE /api/v1/team/members.
Révoquer l'accès d'un membre de l'équipe
post
team:write/api/v1/team/members/revokeCorps de la requête
memberIdstringobligatoire
ID du membre de l'équipe.
Réponse
dataobjectfacultatif
revokedbooleanfacultatif
Erreurs
400Il manque un paramètre requis à la requête, ou elle est invalide.
401Clé API manquante, invalide, expirée ou révoquée.
403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.
404La ressource est introuvable, ou n'appartient pas à votre agence.
409La requête entre en conflit avec l'état actuel de la ressource — par exemple, modifier l'e-mail ou le téléphone d'un destinataire à qui un message a déjà été envoyé, ou une invitation d'équipe déjà acceptée (ou pas encore acceptée).
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
post/api/v1/team/members/revoke
Votre clé API
Corps de la requête*
{}