Skip to main content
Los roles son roles de sistema (como admin o moderator) o roles custom que se gestionan desde el panel. Usa la API de Team Members para listar el equipo de una cuenta, añadir un usuario al equipo con un rol de sistema, cambiar el rol de un miembro y eliminar miembros. Añadir un usuario que todavía no ha aceptado envía una invitación en su lugar.

Endpoints

Atributos

string
requerido
ID del miembro del equipo. Los miembros aceptados tienen un ID que empieza por ausr_ o mber_, y las invitaciones pendientes uno que empieza por ausri_. Trátalo como opaco: ambos prefijos de miembro se aceptan en cualquier lugar donde se acepte un ID de miembro del equipo.
object
requerido
La cuenta a la que pertenece esta membresía.

Propiedades

string
requerido
ID de la cuenta, con el prefijo biz_.
object
Tasas de recargo que esta cuenta principal cobra a la subcuenta que se está leyendo, indexadas por tipo de comisión (por ejemplo crypto_deposit_markup), cada una con percentage_fee y fixed_fee_usd. Se resuelven dando prioridad a las anulaciones propias de la subcuenta sobre el valor predeterminado de la plataforma.
string | null
requerido
URL de la imagen del logo de la cuenta.
string
requerido
Identificador de la ruta pública de la cuenta.
string
requerido
Nombre visible de la cuenta.
object | null
requerido
Rol personalizado asignado a este miembro, o null cuando el miembro tiene un rol de sistema.

Propiedades

string
requerido
ID del rol personalizado, con el prefijo aurl_.
string
requerido
Nombre del rol personalizado.
string
requerido
Cuándo se unió el miembro al equipo o se envió la invitación, como marca de tiempo ISO 8601. Un miembro que primero fue cliente conserva la fecha en que se le asignó su rol.
integer | null
requerido
Cuántos miembros del equipo dependen directamente de este miembro. null para invitaciones.
string | null
requerido
La dirección de correo electrónico del miembro. Para una invitación a un correo electrónico que todavía no tiene cuenta de Whop, es la dirección invitada. En otro caso, es null a menos que quien llama tenga el scope company:authorized_user:email:read.
boolean
requerido
Si este miembro es un agente (una cuenta controlada por una app) en lugar de un miembro humano del equipo. Siempre false para invitaciones.
boolean
requerido
Si este miembro o invitación tiene el rol Partner de solo lectura, directamente o a través de un rol personalizado basado en él. Un Partner solo puede leer los datos básicos de la cuenta.
object[] | null
requerido
Los responsables por encima de este miembro, del más cercano al más lejano: el miembro del que depende, luego el responsable de ese miembro, hasta lo más alto de la línea jerárquica. [] cuando el miembro depende directamente del negocio. Quien llama y solo puede leer su propia línea jerárquica la ve terminar en sí mismo, y null donde no puede leerla. null para invitaciones.

Propiedades

string
requerido
El ID de miembro del equipo del responsable, que empieza por ausr_ o mber_; trátalo como opaco.
object
requerido
El usuario detrás de la membresía de equipo del responsable.

Propiedades

string
requerido
ID de usuario, con el prefijo user_.
string | null
requerido
Nombre visible.
object
requerido
Contenedor del avatar. Su url siempre está presente y es un marcador de posición generado cuando el usuario no definió ninguna imagen.

Propiedades

string
requerido
URL de la imagen del avatar. Siempre está presente. Es un marcador de posición generado cuando el usuario no definió ninguna imagen.
string
requerido
Nombre de usuario público.
string | null
requerido
El ID del miembro del equipo del que depende este miembro, que empieza por ausr_ o mber_; trátalo como opaco. null cuando el miembro depende directamente del negocio, y para invitaciones.
string
requerido
El rol del miembro en la cuenta. custom significa un rol a medida gestionado desde el panel; la API puede leerlo pero no otorgarlo.Opciones disponibles: owner, admin, partner, sales_manager, moderator, advertiser, app_manager, support, manager, workforce, custom
string
requerido
joined para miembros aceptados, pending mientras la invitación está pendiente.Opciones disponibles: joined, pending
string
requerido
Cuándo se actualizó la membresía por última vez, como marca de tiempo ISO 8601.
object | null
requerido
El usuario detrás de esta membresía de equipo. null para una invitación enviada a un correo electrónico que todavía no tiene cuenta de Whop.

Propiedades

string
requerido
ID de usuario, con el prefijo user_.
string | null
requerido
Nombre visible.
object
requerido
Contenedor del avatar. Su url siempre está presente y es un marcador de posición generado cuando el usuario no definió ninguna imagen.

Propiedades

string
requerido
URL de la imagen del avatar. Siempre está presente. Es un marcador de posición generado cuando el usuario no definió ninguna imagen.
string
requerido
Nombre de usuario público.
TeamMember