docs
api
Account Management(UAccount)
invite_subaccount

Invite Sub-account Members - InviteSubaccount

Overview

Invite Sub-account Members

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is InviteSubaccount.Yes
PublicKeystringThe user's public key can be obtained from Console (opens in a new tab)Yes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
UserEmailstringInvited member's email address, must not be duplicated.Yes
UserPhonestringInvited member's mobile numberYes
UserNamestringInvited Member NameYes
IsFinancestringDoes it have financial permissions? (true: yes, false: no, default is no)Yes

Response Field

Field NameTypeDescription InformationRequired
RetCodeintReturn status code. If it is 0, it means successful return. If it is not 0, it means failure.Yes
ActionstringOperation command name.Yes
MessagestringReturns 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
}
  • Company
  • ContactUs
  • Blog
Copyright © 2024 SurferCloud All Rights Reserved