Invite Members

POST/member/invite

Account is created upon invitation. Sign in to complete activation and verify phone or email to receive notifications through corresponding channels

Request

Header Params

Content-Type

string

required

Example:

application/json

members

array [object {5}]

Member List

required

Maximum 20 invites per request, 200 per day

<= 20 items

string

Email Address

optional

At least one of email or phone is required. Email must be verified to receive notifications. The system will guide users to complete or verify information upon sign in

phone

string

Phone Number

optional

At least one of email or phone is required. Phone number must be verified to receive notifications. The system will guide users to complete or verify information upon sign in

country_code

string

Country Code

optional

Default is CN

member_name

string

Member Name

optional

Required when phone is provided; defaults to email prefix when email is provided. Member name must be unique within the account

role_ids

array[integer]

Account Role ID List

optional

Not set if not provided

{
  "members": [
    {
      "email": "string",
      "phone": "string",
      "country_code": "string",
      "member_name": "string",
      "role_ids": [
        0
      ]
    }
  ]
}

Request samples

Responses

成功(200)

HTTP Code: 200

Content Type : JSONapplication/json

error

object (DutyError)

optional

code

enum<string>

Error code

required

Allowed values:

InvalidParameterInvalidContentTypeUnauthorizedAccessDeniedMethodNotAllowedRequestTooFrequentlyRequestVerifyRequiredDangerousOperationRequestLockedRouteNotFoundBalanceNotEnoughUndonedOrderExistResourceNotFoundInternalErrorReferenceExist

message

string

Error description

required

items

array[object (MemberItemShort) {2}]

required

MemberID

integer

required

Member ID

MemberName

string

required

Member name

Not configured

Last modified: 2 个月前