TESTNET
Connect

SubaccountService

Invite Subaccount Member

Create a pending invitation to grant a role on a sub-account.

POST
/v1/auth/subaccounts/{subaccount_id}/invites

Request

Testnet 
curl --request POST \ \
  --url 'https://api.testnet.polyester.com/v1/auth/subaccounts/6789012345678/invites' \
  --header 'Accept: */*' \
  --header 'X-API-KEY-ID: YOUR_API_KEY_ID' \
  --header 'X-API-TIMESTAMP: YOUR_API_TIMESTAMP' \
  --header 'X-API-SIGNATURE: YOUR_API_SIGNATURE' \
  --header 'Content-Type: application/json' \
  --data '{
  "granteeAccountId": "7563897446546",
  "role": "VIEWER"
}'

Responses

{
  "invite": {
    "createdAt": "2025-01-01T00:00:00Z",
    "granteeAccountId": "3J9Vz48X8Cs",
    "granteeRootSmartAccountAddress": "0x2222222222222222222222222222222222222222",
    "granteeUsername": "trader_alpha",
    "id": "4cU63p2qMQ",
    "inviterAccountId": "3C1QrQLB2mg",
    "inviterRootSmartAccountAddress": "0x2222222222222222222222222222222222222222",
    "inviterUsername": "trader_alpha",
    "requireMemberMfa": false,
    "respondedAt": "2025-01-01T00:00:00Z",
    "role": "VIEWER",
    "status": "PENDING",
    "subaccountId": "35VhA2oEvkZ",
    "subaccountLabel": "Market Making"
  }
}
subaccount_id string (int64) required > 0

Sub-account to share (opaque ID).

granteeAccountId string (int64)

Root account ID of the grantee (opaque ID).

role enum required

Role to grant if the invite is accepted.

14 fields
Possible errors: 5
KeyStatusErrorWhen
unauthenticated401UnauthenticatedAuthentication required.
permission-denied403Permission DeniedPermission denied.
invalid-argument400Invalid ArgumentInvalid argument.
not-found404Not FoundNot found.
unavailable503UnavailableService unavailable.