Skip to content
Last updated

🔨 In Development — This section is still being developed and may change.
Invite a new user to join an organization. Only organization admins can send invitations.
POSThttps://api.freddy.aitronos.com/v1/organization/{org_id}/invite-user

Path Parameters

org_id string required

Organization ID (e.g., "ORG_B66136CBB1304C98").

Request Body

email string required

Email address of the user to invite.

role string optional · Defaults to "member"

Role to assign to the invited user. Must be one of: "owner", "admin", "member".

department string optional

Department to assign the user to.

message string optional

Custom invitation message.


Returns

An InviteOrganizationUserResponse object.

Bash
curl -X POST https://api.freddy.aitronos.com/v1/organization/ORG_B66136CBB1304C98/invite-user \
-H "Authorization: Bearer $FREDDY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
  "email": "new.user@company.com",
  "role": "member",
  "department": "Engineering",
  "message": "Welcome to our engineering team!"
}'

Response

{
  "success": true,
  "message": "User invited successfully",
  "email": "new.user@company.com",
  "role": "member",
  "department": "Engineering",
  "invitationId": "inv_1234567890abcdef",
  "invitedAt": "2025-01-15T10:30:00Z",
  "expiresAt": "2025-01-22T10:30:00Z"
}