auth.v1.SubaccountService
InviteSubaccountMember
Invite a member to a sub-account.
Request
curl --request POST \ \
--url 'https://api.testnet.polyester.com/auth.v1.SubaccountService/InviteSubaccountMember' \
--header 'Content-Type: application/json' \
--header 'Connect-Protocol-Version: 1' \
--data '{
"granteeAccountId": "7563897446546",
"role": "VIEWER",
"subaccountId": "6789012345678"
}'Responses
{
"invite": {
"createdAt": "2025-01-01T00:00:00Z",
"granteeAccountId": "7563897446546",
"granteeRootSmartAccountAddress": "0x2222222222222222222222222222222222222222",
"granteeUsername": "trader_alpha",
"id": "1",
"inviterAccountId": "7563897446546",
"inviterRootSmartAccountAddress": "0x2222222222222222222222222222222222222222",
"inviterUsername": "trader_alpha",
"requireMemberMfa": false,
"respondedAt": "2025-01-01T00:00:00Z",
"role": "VIEWER",
"status": "SUBACCOUNT_INVITE_STATUS_PENDING",
"subaccountId": "6789012345678",
"subaccountLabel": "Market Making"
}
}auth.v1.InviteSubaccountMemberRequestauth.v1.InviteSubaccountMemberResponseSub-account to share (opaque ID).
Root account ID of the grantee (opaque ID).
Role to grant if the invite is accepted.
Invite identifier (opaque ID).
Target sub-account (opaque ID).
Grantee root account ID the invite is for (opaque ID).
Inviter root account ID (opaque ID).
Requested role for the grantee.
Current invitation status.
Time when the invitation was created.
Time when the invitation was accepted, declined, or cancelled. Empty while pending.
Optional usernames for better UX in invite lists.
Username of the account that sent the invitation, when available.
Optional label for the target sub-account, for display in invite lists.
Inviter (root account) primary Smart Account address, when available. Useful for displaying a stable identity when no username is set.
Grantee (root account) primary Smart Account address, when available. Useful for displaying a stable identity when no username is set.
Current delegated-member MFA requirement on the target sub-account. If true, accepting the invite requires MFA enrollment and fresh step-up.
| Key | HTTP status | Connect code | Error | When |
|---|---|---|---|---|
| unauthenticated | 401 | unauthenticated | Unauthenticated | Authentication required. |
| permission-denied | 403 | permission_denied | Permission Denied | Permission denied. |
| invalid-argument | 400 | invalid_argument | Invalid Argument | Invalid argument. |
| not-found | 404 | not_found | Not Found | Not found. |
| unavailable | 503 | unavailable | Unavailable | Service unavailable. |