Skip to content

Accept an invitation

Accept an invitation to join an organization or team, or take over billing ownership. Accepting an organization invitation can also accept pending invitations to its teams.

Parameters

#
invitationstringRequired
Pending invitation ID, organization name or ORGANIZATION@TEAM for a team invitation. Use invitation view to find the ID.

Returns

#
dataobjectAlways present
The account and person associated with an invitation decision.
Show 3 attributesHide attributes
account_idstringAlways present
Account the invitation concerns.
not_joinedstring
Reason an accepted organization invitation could not also join its team. May be omitted.
user_idstringAlways present
Person whose invitation was decided.

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.