Invite members - Flashcat API (English)

Request

Header Params

Content-Type

string

required

Example:

application/json

Body Params application/json

members

array [object {6}]

Member list

required

Maximum 20 invites per request, 200 per day

<= 20 items

email

string

Email address

optional

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

phone

string

Phone

optional

At least one of email or phone is required. Phone must be verified to receive notifications. Members will be guided 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 only email is provided. Member name must be unique within the account

ref_id

string

Refence ID

optional

role_ids

array[integer]

Account role ID list

optional

Not set if not provided

Example

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

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'http://prod-cn.your-api-server.com/member/invite' \
--header 'Content-Type: application/json' \
--data-raw '{
    "members": [
        {
            "email": "string",
            "phone": "string",
            "country_code": "string",
            "member_name": "string",
            "ref_id": "string",
            "role_ids": [
                0
            ]
        }
    ]
}'

Responses

🟢200成功

application/json

Body

error

object (DutyError)

optional

code

enum<string>

Rule description

required

Allowed values:

InvalidParameterInvalidContentTypeUnauthorizedAccessDeniedMethodNotAllowedRequestTooFrequentlyRequestVerifyRequiredDangerousOperationRequestLockedRouteNotFoundBalanceNotEnoughUndonedOrderExistResourceNotFoundInternalErrorReferenceExist

message

string

Inner conditions

required

items

array[object (MemberItemShort) {2}]

required

MemberID

integer

required

Channel

MemberName

string

required

Rule name

Example

{
    "error": {
        "code": "InvalidParameter",
        "message": "string"
    },
    "items": [
        {
            "MemberID": 0,
            "MemberName": "string"
        }
    ]
}