跳转到主要内容
POST
/
member
/
invite
邀请成员
curl --request POST \
  --url 'https://api.flashcat.cloud/member/invite?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "members": [
    {
      "member_name": "Charlie",
      "email": "charlie@example.com",
      "locale": "en-US",
      "time_zone": "Asia/Shanghai",
      "role_ids": [
        6
      ]
    }
  ]
}
'
{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "items": [
      {
        "member_id": 5068740052131,
        "member_name": "Charlie"
      }
    ]
  }
}

限制说明

项目说明
速率限制每个账户 1,000 次/分钟50 次/秒
权限要求无 —— 持有有效的 app_key 即可调用

授权

app_key
string
query
必填

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

请求体

application/json

邀请成员请求

members
object[]
必填

待邀请成员列表(最多 20 个)

from
string

邀请来源上下文

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object
必填

邀请成员响应