POST Invite (inviteMember)

Developing

POST

/api/users/invite

Send an invitation email to invite a new member to the current tenant organization. Dispatches a queued job (SendMemberInvitation) that creates the user record (if needed), attaches to org with pending status, and sends an email. The invited user must accept via 3rd-party signup before gaining access.

Permission: view users (route-level permission:view users,api).

Request

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200Success

application/json

Bodyapplication/json

🟠401Unauthorized

🟠403Forbidden

🟠422Unprocessable Entity

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api-dev.commandroom.ai/api/api/users/invite' \
--header 'Authorization: Bearer {{token}}' \
--header 'X-Tenant-UUID: ' \
--header 'Content-Type: application/json' \
--data-raw '{
  "email": "user@example.com",
  "name": "Sample Name",
  "role": "Member"
}'

Response Example

200 - OK

{
  "message": "Success.",
  "data": {
    "email": "user@example.com",
    "name": "Sample Name",
    "role": "Member",
    "status": "active"
  }
}

Modified at 2026-07-02 04:47:16

GET Users (organizationUsers)

GET Item (show)