Skip to content

by Startups.Studio

Core grammar Tenant

Tenant.invite

POST /{namespace}/tenants/{tenant}/invite

Invite asks a Person to join a Customer’s Tenant, and resizes the Subscription when the Offer prices per member.

Noun: Tenant
Mode: do
Event: Tenant.invited

You, to your agent

Invite the latest tenant.

curl -X POST https://api.sb/routewise.dev/tenants/tenant_1/invite \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"email":"hana@routewise.dev"}'

import { $ } from 'startup-builder'

const { person, tenant } = await $.Tenant.invite({ tenant: 'tenant_1', email: 'hana@routewise.dev' })

npx startup-builder do Tenant.invite --json '{"tenant":"tenant_1","email":"hana@routewise.dev"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Tenant.invite({ tenant: 'tenant_1', email: 'hana@routewise.dev' })"
  }
}

Inputs

Input	Type	Required	Description
`tenant`	Tenant	required	The Customer’s Tenant.
`email`	`email`	required	Where the invitation goes.

Outputs

Output	Type	Required	Description
`person`	Person	required	The invited Person.
`tenant`	Tenant	required	The Tenant the Person was invited to.

Effects

Emits Tenant.invited.
Performed by the Security Engineer.
Two-way: it runs at once, in the try, send and do modes.
Adds one unit through Subscription.resize when no unit is free.
Grants the Tenant’s Entitlements to the Person once they accept.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	Tenant.invite

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Tenant.get

Previous Page

Tenant.list

Next Page