beel_create_invitation
Create a single-use invitation to join an account, specifying role and company grants, and receive the acceptance token to deliver to the invitee.
Instructions
Creates a single-use invitation for a person to join the account with the given account_role, and returns its acceptance token once — it is never readable again, so deliver it to the invitee. grants is required: send the companies a MEMBER starts with, or [] to invite them with no company access yet. Grants are only valid for MEMBER, since OWNER and ADMIN reach every company implicitly. OWNER cannot be invited — an account has exactly one owner, handed over only through PUT /v1/accounts/{account_id}/owner.
By default BeeL sends no email and you deliver the token or invitation_url yourself; set send_email to true to have the invitation emailed to invited_email as well.
Endpoint: POST /v1/accounts/{account_id}/invitations
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | ||
| account_id | Yes | Your own account, or an account you provisioned. It — not the credential — decides which account the operation acts on; a `403` is returned when you do not reach it, the same response an account that does not exist gets. | |
| idempotency_key | No | Optional idempotency key for this operation. Omit it and one is derived from the request itself, which makes a blind retry safe but also collapses a SECOND, deliberately identical operation into the first for 24 hours. Set it — to an order id, or anything unique per intended operation — whenever you mean to create something that may look identical to what you just created. |