swap.quickswap.v1.QuickSwapBrokerService
InviteMember
InviteMember invites a person with any role but OWNER; the person accepts with their own login. Inviting again replaces the pending invite. Session token and step-up proof only. Errors: - NOT_FOUND: BROKER_NOT_FOUND, or MEMBER_NOT_FOUND when the account does not exist. - PERMISSION_DENIED: ACTION_DENIED or STEP_UP_REQUIRED. - ALREADY_EXISTS: ALREADY_MEMBER.
Method
POST
Path
swap.quickswap.v1.QuickSwapBrokerService/InviteMember
Service
swap.quickswap.v1.QuickSwapBrokerService
Visibility
Authentication
Session token
MFA Requirement
Not required
POST
swap.quickswap.v1.QuickSwapBrokerService/InviteMember Request
Testnet
curl --request POST \ \
--url 'https://api.testnet.polyester.com/swap.quickswap.v1.QuickSwapBrokerService/InviteMember' \
--header 'Content-Type: application/json' \
--header 'Connect-Protocol-Version: 1' \
--data '{
"accountId": "7563897446546",
"broker": "value",
"role": "OWNER"
}'Responses
{
"invite": {
"accountId": "7563897446546",
"broker": "value",
"brokerDisplayName": "value",
"createdAt": "2025-01-01T00:00:00Z",
"inviteId": "1",
"invitedByAccountId": "7563897446546",
"role": "OWNER"
}
}Request
swap.quickswap.v1.InviteMemberRequestResponse
swap.quickswap.v1.InviteMemberResponse broker string
Broker name.
accountId string (fixed64)
Public account ID of the person's own account.
role enum
Role the person gets on accepting; never OWNER.
7 fields
inviteId string (fixed64)
Public invite ID.
broker string
Broker name.
brokerDisplayName string
Broker display name.
accountId string (fixed64)
Public account ID of the invited person.
role enum
Role the person gets on accepting.
OWNER ADMIN FINANCE AFFILIATE_MANAGER VIEWER
invitedByAccountId string (fixed64)
Public account ID of the member who invited them.
createdAt string (date-time)
When the invite was sent.
| 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. |