Skip to main content
POST
Invite a Team Member
Notas de seguridad y comportamiento
  • La operación crea una invitación de membresía y envía un correo externo de forma predeterminada.
  • HTTP 200 tiene tres resultados distintos, separados del resultado de creación HTTP 201; revisa los campos de la respuesta.
  • La invitación permanece guardada cuando falla el envío del correo; revisa email_sent.
  • send_email tiene true como valor predeterminado.
  • Las comprobaciones already_member y reused se ejecutan antes de dry_run, por lo que una simulación puede devolver esos estados en lugar de status=dry_run, aunque sigue sin escribir.

Autorizaciones

X-API-Key
string
header
requerido

API key for authentication. Keys are prefixed with nxr_live_.

Cuerpo

application/json
email
string<email>
requerido
role
enum<string>
requerido
Opciones disponibles:
admin,
human_agent
invitee_name
string
send_email
boolean
predeterminado:true
dry_run
boolean
predeterminado:false

Respuesta

Already-member, reused-pending, or dry-run result.

success
enum<boolean>
requerido
Opciones disponibles:
true
status
enum<string>
requerido
Opciones disponibles:
already_member
email_sent
enum<boolean>
requerido
Opciones disponibles:
false
Última modificación el 8 de septiembre de 2026