Skip to content

Invite One or Multiple Members¶

POST /api/v1/workspace/member/batch_invitation

Overview¶

Invite one or multiple members

Body Request Parameters¶

Parameter Name	Type	Required	Description
to	array	Y	List of invitees Example: ['xx1@jiagouyun.com', 'xx2@jiagouyun.com'] Can be empty: True
roleUUIDs	array	Y	List of role UUIDs for invitees Example: ['xxx', 'xxx'] Can be empty: False
method	string	Y	Invitation method Example: None Can be empty: False Optional values: ['email']

Additional Parameter Explanation¶

Request Example¶

curl 'https://openapi.guance.com/api/v1/workspace/member/batch_invitation' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"to": ["241927@qq.com"], "method": "email", "roleUUIDs": ["general"]}' \
--compressed

Response¶

{
    "code": 200,
    "content": true,
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-B6A69C1D-ED27-42C2-93FD-BC943F8675D2"
}