发送邀请

开发环境

http://dev-cn.your-api-server.com

POST

/v1 /projects/ {project_id} /invites

发送邀请

需要具备的账户权限范围：owners:write、admins:write。需要的项目权限范围：project:write、members:write:invites、admins:write:invites、owners:write:invites。

详细信息请阅读有关角色和权限范围的更多内容。当发送邀请时，你通常需要提供接收者的邮箱地址，并通过系统生成的邀请链接进行发送，该操作需要相应的写入权限来执行。

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://dev-cn.your-api-server.com/v1 /projects/  /invites' \
--header 'content-type: application/json' \
--data-raw '{
    "email": "string",
    "scope": "string"
}'

响应示例

200 - 成功示例

{
  "message": "Sent an invite!"
}

请求参数

Path 参数

project_id

string

必需

您要为其发送邀请的项目的唯一标识符。（通用唯一标识）

Header 参数

content-type

string

必需

示例值:

application/json

Body 参数application/json

string

必需

邀请加入项目的电子邮件

scope

string

给予用户的范围

必需

示例

返回响应

🟢200成功

application/json

Body

message

string

必需

🟠403禁止访问

🟠404记录不存在

获取邀请

删除邀请