beel_create_claim_token
Issues a single-use claim_token, and the claim_url built from it, so the account's
holder can set a password and take ownership.
email: send it when the account has no holder yet — the person is created by this call. Omit the body to re-issue the token for the holder the account already has. Anemailthat differs from the existing holder's is rejected rather than replacing them.Lifetime: tokens last 30 days, and only the last one issued is live. Issuing again invalidates the previous token, so the old link stops working the moment you ask for a new one.
Not an invitation: this hands the account itself over to its holder. To add a further person to an account that already has one, invite them with
POST /v1/accounts/{account_id}/invitations.Entitlement: requires
manage_accounts.
Endpoint: POST /v1/accounts/{account_id}/claim-tokens
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| body | No | ||
| account_id | Yes | ||
| 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. |