Parameters
#userstringRequired
The person to invite, by email address or user ID.
rolestring
Role the recipient receives on acceptance.
user is the default. admin grants organization administration. billing_owner transfers billing ownership and can be offered only by the billing owner.grantsstring[]
Additional management command to give the member across the organization. Give the command name as listed in
help.withholdsstring[]
Management command to exclude from the role. Give the command name as listed in
help.teamsstring[]
A team the person joins when accepting the invitation.
organizationstring
Organization name or ID. A credential, named resource or sole membership can select the organization for you.
Returns
#dataobjectAlways present
An invitation awaiting the recipient's acceptance.
Show 2 attributesHide attributes
grant_scopestring
Resources on which the invited command grants apply, when grants were included. May be omitted.
invite_idstringAlways present
Invitation ID.
Errors
#| Code | Status | What happened |
|---|---|---|
| invalid | 400 | An input is missing or invalid. |
| unauthenticated | 401 | The credential is missing, invalid, expired or revoked. |
| denied | 403 | The caller lacks permission for this action. |
| not_found | 404 | The resource is absent or inaccessible to this caller. |
| conflict | 409 | The request conflicts with the current resource state or an earlier request. |
| over_capacity | 409 | The request exceeds a resource or credential allowance. |
| access_list_full | 409 | The change would exceed the access-list allowance. |
| payment_required | 402 | Payment or credit is required. |
| rate_limited | 429 | The caller's request rate exceeds its limit. |
| busy | 429 | Too much work is in progress to accept this request. |
| unknown | 503 | The outcome is unconfirmed; a change may have happened. |
| unavailable | 503 | The service or requested feature is unavailable. |
Notes
#- CLI:
heaven loginwithHEAVEN_API_KEYunset. MCP: Heaven sign-in. cURL:HEAVEN_SIGN_IN_KEYfrom approved device sign-in (POST /v1/auth/create). - A key limited to a command list cannot run this command.