back-office

Invite Customer

Invite a customer (by email) into a tenant. The invitation link directs them to the app scoped to their tenant, not the free-trial flow (IBS-1282).

post/back-office/tenants/{public_id}/invitations

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/back-office/tenants/{public_id}/invitations
  • Auth: HTTP bearer

Path parameters

public_idstring uuid required

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.