v1Recursos/Team
Team
Gestione la plantilla del equipo de su agencia — liste a los miembros, invite a otros nuevos, actualice su capacidad, sus permisos o su usuario de Slack vinculado, y reenvíe o revoque invitaciones. Nota: emitir una clave de API con team:write requiere que la persona que crea la clave ya sea propietaria, administradora, o miembro del personal de Synup. Esa comprobación ocurre una sola vez, en Configuración, al crear la clave — no en cada solicitud individual — así que, si su intento de crear una clave team:write es rechazado, esta es la razón, aunque las llamadas REST documentadas a continuación nunca vuelvan a comprobarlo por sí mismas.
Devuelve la plantilla del equipo de su agencia — todos los usuarios de su agencia excepto el Synup Bot propio de cada agencia.
Listar miembros del equipo
get
team:read/api/v1/team/membersRespuesta
dataarray of objectopcional
idstringopcional
Identificador único del miembro del equipo.
firstNamestringopcional
El nombre del miembro del equipo.
lastNamestringopcional
El apellido del miembro del equipo.
emailstringopcional
La dirección de correo electrónico del miembro del equipo.
rolestringopcional
El rol del miembro del equipo, p. ej. "owner" o "member".
invitationStatusstringopcional
El estado de invitación del miembro: "invited", "accepted", o null para un miembro que nunca pasó por el flujo de invitación.
lastSessionAtstringopcional
Cuándo tuvo el miembro su última sesión activa, como marca de tiempo ISO 8601, o null si nunca.
createdAtstringopcional
Cuándo se creó el miembro del equipo, como marca de tiempo ISO 8601.
weeklyHoursCapacitynumberopcional
La capacidad de horas de trabajo semanales del miembro, o null si no está establecida.
permissionsobjectopcional
Indicadores de acceso por módulo (dashboard, clients, listings, etc.), o null si nunca se establecieron.
slackUserIdstringopcional
El ID de usuario de Slack vinculado a este miembro, o null si no hay ninguno.
statusstring (Owner | Invited | Active | Not Active)opcional
Un resumen calculado del estado del miembro: "Owner", "Invited", "Active", o "Not Active" (aceptó pero sin sesión en los últimos 7 días).
Errores
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
get/api/v1/team/members
Su clave de API
{}v1Recursos/Team/postInvitar a un miembro del equipo
Invita a un nuevo miembro del equipo por correo electrónico. El miembro invitado siempre se crea con el rol "member" y, salvo que se indiquen permissions, con la plantilla de permisos predeterminada de miembro — una clave de API nunca puede invitar a alguien como owner o admin.
Invitar a un miembro del equipo
post
team:write/api/v1/team/membersCuerpo de la solicitud
firstNamestringobligatorio
El nombre del nuevo miembro del equipo.
lastNamestringobligatorio
El apellido del nuevo miembro del equipo.
emailstringobligatorio
La dirección de correo electrónico del nuevo miembro del equipo.
permissionsobjectopcional
Indicadores de acceso por módulo a otorgar. Opcional; cuando se omite (o está vacío), se usa la plantilla de permisos predeterminada de miembro.
Respuesta
dataobjectopcional
userIdstringopcional
ID del miembro del equipo recién invitado.
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
409La solicitud entra en conflicto con el estado actual del recurso — por ejemplo, cambiar el correo electrónico o el teléfono de un destinatario al que ya se le ha enviado un mensaje, o una invitación de equipo que ya fue aceptada (o que aún no ha sido aceptada).
422A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
post/api/v1/team/members
Su clave de API
Cuerpo de la solicitud*
{}v1Recursos/Team/patchActualizar un miembro del equipo
Actualiza la capacidad de horas semanales, los permisos por módulo o el usuario de Slack vinculado de un miembro del equipo. Se debe indicar al menos un campo. Esto no puede cambiar el rol de un miembro.
Actualizar un miembro del equipo
patch
team:write/api/v1/team/membersCuerpo de la solicitud
memberIdstringobligatorio
ID del miembro del equipo.
weeklyHoursCapacitynumberopcional
Nueva capacidad de horas de trabajo semanales, entre 0 y 80.
permissionsobjectopcional
Indicadores de acceso por módulo a otorgar. Opcional; cuando se omite (o está vacío), se usa la plantilla de permisos predeterminada de miembro.
slackUserIdstringopcional
ID de usuario de Slack a vincular con este miembro, o null para desvincular. Vincular un ID de Slack ya usado por otro miembro lo desvincula de ese miembro.
Respuesta
dataobjectopcional
memberobjectopcional
Los campos realmente modificados por esta actualización — no el perfil completo del miembro. Consulte GET /api/v1/team/members para ver el registro completo.
idstringopcional
Identificador único del miembro del equipo.
weeklyHoursCapacitynumberopcional
La capacidad de horas de trabajo semanales del miembro, o null si no está establecida.
permissionsobjectopcional
Indicadores de acceso por módulo (dashboard, clients, listings, etc.), o null si nunca se establecieron.
slackUserIdstringopcional
El ID de usuario de Slack vinculado a este miembro, o null si no hay ninguno.
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
404El recurso no se encontró, o no pertenece a su agencia.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
patch/api/v1/team/members
Su clave de API
Cuerpo de la solicitud*
{}v1Recursos/Team/deleteEliminar un miembro del equipo
Elimina a un miembro del equipo de la agencia. El propietario de la agencia no se puede eliminar.
Eliminar un miembro del equipo
delete
team:write/api/v1/team/membersParámetros de consulta
memberIdstringobligatorio
ID del miembro del equipo a eliminar.
Respuesta
dataobjectopcional
removedbooleanopcional
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
404El recurso no se encontró, o no pertenece a su agencia.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
delete/api/v1/team/members
Su clave de API
memberId *
{}v1Recursos/Team/postReenviar una invitación de equipo
Genera un nuevo enlace de invitación y reenvía el correo de invitación a un miembro del equipo que aún no la ha aceptado.
Reenviar una invitación de equipo
post
team:write/api/v1/team/members/resend-inviteCuerpo de la solicitud
memberIdstringobligatorio
ID del miembro del equipo.
Respuesta
dataobjectopcional
resentbooleanopcional
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
404El recurso no se encontró, o no pertenece a su agencia.
409La solicitud entra en conflicto con el estado actual del recurso — por ejemplo, cambiar el correo electrónico o el teléfono de un destinatario al que ya se le ha enviado un mensaje, o una invitación de equipo que ya fue aceptada (o que aún no ha sido aceptada).
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
post/api/v1/team/members/resend-invite
Su clave de API
Cuerpo de la solicitud*
{}v1Recursos/Team/postRevocar el acceso de un miembro del equipo
Elimina a un miembro del equipo que ya ha aceptado su invitación. El propietario de la agencia no se puede revocar, y a un miembro que aún no ha aceptado su invitación se le debe eliminar en su lugar con DELETE /api/v1/team/members.
Revocar el acceso de un miembro del equipo
post
team:write/api/v1/team/members/revokeCuerpo de la solicitud
memberIdstringobligatorio
ID del miembro del equipo.
Respuesta
dataobjectopcional
revokedbooleanopcional
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
404El recurso no se encontró, o no pertenece a su agencia.
409La solicitud entra en conflicto con el estado actual del recurso — por ejemplo, cambiar el correo electrónico o el teléfono de un destinatario al que ya se le ha enviado un mensaje, o una invitación de equipo que ya fue aceptada (o que aún no ha sido aceptada).
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
post/api/v1/team/members/revoke
Su clave de API
Cuerpo de la solicitud*
{}