Team upsert - Flashcat API (English)

Request

Header Params

Content-MD5

string

required

Example:

application/json

Body Params application/json

team_id

integer

Team ID

optional

team_name

string

Team name

required

Team name must be unique within the account

reset_if_name_exist

boolean

Update by name

optional

If team ID is not provided but team name exists, when this value is true, the team with the same name will be updated; otherwise, update will be rejected with duplicate name error

description

string

Team description

required

ref_id

string

Refence ID

optional

person_ids

array[integer]

Member ID list

optional

At least one of email, phone, or ID list is required. When multiple are provided, system will merge them

emails

array[string]

Member email list

optional

At least one of email, phone, or ID list is required. When multiple are provided, system will merge them. When an email is used by both owner and member, both will be invited to join the team

phones

array[string]

Member phone list

optional

At least one of email, phone, or ID list is required. When multiple are provided, system will merge them. When a phone is used by both owner and member, both will be invited to join the team

Example

{
    "team_id": 0,
    "team_name": "string",
    "reset_if_name_exist": true,
    "description": "string",
    "ref_id": "string",
    "person_ids": [
        0
    ],
    "emails": [
        "string"
    ],
    "phones": [
        "string"
    ]
}

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/team/upsert' \
--header 'Content-MD5: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
    "team_id": 0,
    "team_name": "string",
    "reset_if_name_exist": true,
    "description": "string",
    "ref_id": "string",
    "person_ids": [
        0
    ],
    "emails": [
        "string"
    ],
    "phones": [
        "string"
    ]
}'

Responses

🟢200成功

application/json

Body

error

object (DutyError)

optional

code

enum<string>

Rule description

required

Allowed values:

InvalidParameterInvalidContentTypeUnauthorizedAccessDeniedMethodNotAllowedRequestTooFrequentlyRequestVerifyRequiredDangerousOperationRequestLockedRouteNotFoundBalanceNotEnoughUndonedOrderExistResourceNotFoundInternalErrorReferenceExist

message

string

Inner conditions

required

data

object

optional

team_id

integer

optional

Example

{
    "error": {
        "code": "InvalidParameter",
        "message": "string"
    },
    "data": {
        "team_id": 0
    }
}