Skip to content

Invite a member

Invite someone to an organization with a role, command permissions and optional team membership. The invitation expires after seven days. Membership starts when the recipient accepts.

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

#
CodeStatusWhat happened
invalid400An input is missing or invalid.
unauthenticated401The credential is missing, invalid, expired or revoked.
denied403The caller lacks permission for this action.
not_found404The resource is absent or inaccessible to this caller.
conflict409The request conflicts with the current resource state or an earlier request.
over_capacity409The request exceeds a resource or credential allowance.
access_list_full409The change would exceed the access-list allowance.
payment_required402Payment or credit is required.
rate_limited429The caller's request rate exceeds its limit.
busy429Too much work is in progress to accept this request.
unknown503The outcome is unconfirmed; a change may have happened.
unavailable503The service or requested feature is unavailable.

Notes

#
  • CLI: heaven login with HEAVEN_API_KEY unset. MCP: Heaven sign-in. cURL: HEAVEN_SIGN_IN_KEY from approved device sign-in (POST /v1/auth/create).
  • A key limited to a command list cannot run this command.