跳转到主要内容
POST
/
team
/
upsert
变更团队信息
curl --request POST \
  --url 'https://api.flashcat.cloud/team/upsert?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "team_name": "后端 SRE",
  "description": "后端可靠性工程团队",
  "person_ids": [
    80011,
    80012
  ]
}
'
{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "team_id": 1001,
    "team_name": "后端 SRE"
  }
}

限制说明

项目说明
速率限制每个账户 1,000 次/分钟50 次/秒
权限要求团队管理organization

使用说明

  • 省略 team_id(或置为 0)表示创建新团队;传入已有 ID 表示更新。
  • team_name 须为 1–39 个字符且在账户内唯一。
  • 传入 person_ids 可设置团队成员,会替换整个成员列表。
  • 传入 emailsphones 可邀请尚未注册的成员。
  • ref_id 是供第三方 HR 系统集成使用的外部标识。
  • 每次调用都会记录到账户审计日志,请不要把敏感信息放在请求字段中。

授权

app_key
string
query
必填

在 Flashduty 控制台 账户 → APP Key 中签发的 app_key。调用任何公开 API 时都必须携带。它等同于所属账户的身份凭证,请妥善保管。

请求体

application/json

创建或更新团队的参数。

team_name
string
必填

团队显示名称,1–39 个字符。

Required string length: 1 - 39
team_id
integer<uint64>

团队 ID,省略或置为 0 表示创建新团队。

description
string

自定义描述。

Maximum string length: 500
person_ids
integer<uint64>[]

设置为团队成员的成员 ID 列表,会替换现有成员列表。

emails
string<email>[]

要邀请为成员的邮箱地址。

phones
string[]

要邀请为成员的手机号码。

countryCode
string

默认国家区号,用于 phones 中未采用 E.164 格式的手机号。

ref_id
string

供 HR 系统集成使用的外部引用 ID。

reset_if_name_exist
boolean

若为 true,当同名团队已存在时重置其成员列表为传入的 person_ids。

响应

成功

成功响应结构。2xx 响应中 request_id 标识本次调用(同时出现在 Flashcat-Request-Id 响应头中),data 为接口业务 payload。失败响应使用不同结构,参见 ErrorResponse

request_id
string
必填

本次请求的唯一 ID,也会在 Flashcat-Request-Id 响应头中返回。反馈问题时请一并附上。

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object
必填

创建或更新团队的结果。