users

Invite User

Invite a user to join the current tenant with the given role (admin-only). Sends via Descope or records our own invitation (IBS-2466), depending on OWN_INVITATIONS_ENABLED — see invitations_service._invite_to_org.

post/users/invite

Request

  • Base URL: https://api.incredibuild.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.incredibuild.com/users/invite
  • Auth: HTTP bearer

Headers

x-public-tenant-idstring uuid nullable
x-public-user-idstring uuid nullable

Request body

emailstring email required
role'admin' | 'member'

Tenant permission tier (IBS-1136). The public API uses the lowercase values; while the Descope mirror writes continue they map to its role names ("Admin"/"Viewer", member being Viewer).

Response

Successful Response

emailstring required
messagestring required

Changes

No recorded changes to this operation across all 1 revision of this API.