Resend workspace invitations in bulk
<Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>
Resends up to 50 pending workspace invitations at once, the same way as Resend workspace invitation.
Each invitation succeeds or fails on its own, so a 200 doesn't mean every invitation went out. Check failed, which lists emails with no pending invitation, people who already joined, invitations resent too often, invitations for admin when the plan no longer allows admins, and invitations that couldn't be saved or emailed. Each invitation can be resent 3 times every 10 minutes.
Inviting is limited to 6 requests per minute, shared by Invite workspace member, Invite workspace members in bulk, Resend workspace invitation, and Resend workspace invitations in bulk. A signed-in session has its own limit, and every personal access token for the workspace shares one. Some workspaces have a different limit.
<Note>Call this as an owner or admin of the workspace, with a personal access token for that workspace sent as a Bearer token, or from a signed-in session. A read-only token is refused, and workspace API keys aren't accepted.</Note>
Query parameters
ID of the workspace. With a personal access token, use the token's workspace. Get it from organization_id in Get app.
ID of the workspace. With a personal access token, use the token's workspace. Get it from organization_id in Get app.
Request body
Example request
{
"emails": [
"dana@acme.com",
"sam@acme.com"
]
}Response
Which invitations went out.
Example response
{
"total_sent": 1,
"successful": [
"dana@acme.com"
],
"failed": [
{
"email": "sam@acme.com",
"error": "User already has a pending invitation"
}
]
}Changes
Changed in 1 of the 39 revisions of this API.1
- ○
endpoint added
endpoint-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○