Add a member to a business account
Platform-credential counterpart of the SDK addMember: the caller names the member. Governance is bypassed — the member is always added directly, never proposed. No TokenScopes.BusinessAccountsWrite scope yet — access is gated by the caller’s role.
Authorizations
Path Parameters
Body
The user to add as a member and the role to grant them.
A role that can be directly assigned to a member: a built-in (admin, viewer) or a customer-defined role the account has defined. owner is excluded — ownership moves only via transferOwnership.
Not an enum, because the set is per-account: a caller can grant any role from GET /roles. Whether the role exists is the enclave's to answer, not this schema's — the pattern only rejects names that could never be one. A role the account has not defined is refused with UNKNOWN_ROLE.
A customer-defined role grants exactly what it inherits, so cfo inherits admin is an admin with a distinguishable name.
Case-insensitive on input — CFO and cfo name the same role. The server normalizes to lowercase before comparing or storing, so the pattern accepts both cases here even though a held/stored role name (HeldBusinessAccountMemberRole) is always lowercase.
^[a-zA-Z0-9](?:[a-zA-Z0-9_-]{0,30}[a-zA-Z0-9])?$"cfo"
The 'turnkey' value is deprecated and will be removed in a future version.
emailOnly, magicLink, apple, bitbucket, coinbasesocial, discord, epicgames, facebook, farcaster, github, gitlab, google, instagram, linkedin, microsoft, twitch, twitter, blocto, banxa, coinbaseOnramp, binanceOnramp, robinhoodOnramp, cryptoDotCom, moonPay, dynamic, alchemy, zerodev, telegram, turnkey, coinbaseWaas, sms, spotify, tiktok, line, steam, shopify, zksync, kraken, blockaid, passkey, okta, sendgrid, resend, trmWalletScreening, chainalysisAddressScreening, gemini, ellipticAddressScreening Response
Member added, or invite sent when member invites are enabled
- Option 1
- Option 2
The active member when membership is created immediately, or the invite receipt when acceptance is required.
The role a member actually holds: a built-in (owner, admin, viewer) or a customer-defined role the account has defined. Wider than AssignableBusinessAccountRoleName because a held role can be owner, which cannot be assigned directly.
^[a-z0-9](?:[a-z0-9_-]{0,30}[a-z0-9])?$"cfo"