Skip to main content
POST
Invite a Team Member
Safety and behavior notes
  • The operation creates a membership invitation and sends an external email by default.
  • HTTP 200 has three distinct outcomes, separate from the HTTP 201 creation outcome; inspect the response fields.
  • The invitation remains persisted when email delivery fails; inspect email_sent.
  • send_email defaults to true.
  • already_member and reused checks run before dry_run, so a dry run can return those statuses instead of status=dry_run, while still avoiding writes.

Authorizations

X-API-Key
string
header
required

API key for authentication. Keys are prefixed with nxr_live_.

Body

application/json
email
string<email>
required
role
enum<string>
required
Available options:
admin,
human_agent
invitee_name
string
send_email
boolean
default:true
dry_run
boolean
default:false

Response

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

success
enum<boolean>
required
Available options:
true
status
enum<string>
required
Available options:
already_member
email_sent
enum<boolean>
required
Available options:
false
Last modified on September 8, 2026