Browse the API reference

Invite Member

post/v1/orgs/{org_id}/invitations

Part of Org Members.

Invite a new user to the organization by email. Disabled by default (ORG_MEMBER_INVITATIONS_ENABLED=false); returns 501 when disabled. Requires admin or owner role. Only emails without an existing account can be invited.

Authentication

Authenticate in any one of these ways — not all of them:

  • API key in the X-API-Key header.
  • Bearer token in the Authorization header.

Path parameters

NameTypeDescription
org_idrequiredstringOrg Id

Request body

Required, application/json.

FieldTypeDescription
emailrequiredstring (email)
roleoptionalOrgRole

One of: owner, admin, member

Default: member

Example request

curl
curl -X POST "https://api.robosystems.ai/v1/orgs/{org_id}/invitations" \
  -H "X-API-Key: $ROBOSYSTEMS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "user@example.com"
}'

Responses

201 Successful Response

FieldTypeDescription
idrequiredstring
org_idrequiredstring
emailrequiredstring
rolerequiredOrgRole

One of: owner, admin, member

statusrequiredstring
invited_by_user_idrequiredstring
invited_by_namerequiredstring
created_atrequiredstring (date-time)
expires_atrequiredstring (date-time)
is_expiredrequiredboolean
tokenoptionalstring

Test-support only: the raw invite token. Populated ONLY when AUTH_INVITE_TOKEN_IN_RESPONSE is enabled in a non-production environment; always null in production. Lets automated authorization tests complete the invite -> register flow without email interception.

StatusMeaning
400Invalid request
401Authentication required
403Access denied
404Resource not found
409Email already registered or invited
422Validation Error
429Rate limit exceeded
500Internal server error
501Feature not enabled