Invite Sub-account Members - InviteSubaccount
Overview
Invite Sub-account Members
Definition
Public Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Action | string | Corresponding API command name, the current API is InviteSubaccount . | Yes |
PublicKey | string | The user's public key can be obtained from Console (opens in a new tab) | Yes |
Signature | string | User signature generated based on public key and API command, see Signature Algorithm | Yes |
Request Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
UserEmail | string | Invited member's email address, must not be duplicated. | Yes |
UserPhone | string | Invited member's mobile number | Yes |
UserName | string | Invited Member Name | Yes |
IsFinance | string | Does it have financial permissions? (true: yes, false: no, default is no) | Yes |
Response Field
Field Name | Type | Description Information | Required |
---|---|---|---|
RetCode | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. | Yes |
Action | string | Operation command name. | Yes |
Message | string | Returns an error message, providing detailed description when RetCode is non-zero. | No |
Example
Request Example
https://api.surfercloud.com/?Action=InviteSubaccount
&UserEmail=lOqBhhkG
&UserPhone=SBwrZBSY
&UserName=mdHhPdnD
&IsFinance=IvixWFse
Response Example
{
"Action": "InviteSubaccountResponse",
"RetCode": 0
}