Organization

Invite or update a user

Sends an invitation to a user to join the organization. If the user is already a member, updates their role to the specified value. If the user has a pending invite, returns the current status without changes. If the organization has reached its seat limit, returns status "error" with a descriptive error message.

post/api/v0/organization/users/invite

Request

  • Base URL: https://api.factory.ai
  • URL: https://api.factory.ai/api/v0/organization/users/invite
  • Auth: HTTP bearer

Request body

emailstring email required

Email address to invite

role'user' | 'manager' | 'owner'

Role to assign (defaults to user)

Response

Response for status 200

emailstring email required

Invited email address

role'user' | 'manager' | 'owner' required

Assigned role

status'invited' | 'already_member' | 'role_updated' | 'already_invited' | 'error' required

Result of the invite operation

errorstring

Error message if status is error

Changes

No recorded changes to this operation across all 44 revisions of this API.