Sign in

Resend workspace invitation

<Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>

Sends a pending workspace invitation again, with a new link. The previous link stops working, and the new one works for 60 days. The invitation keeps its role and group.

Only a pending invitation can be resent, including one that expired. Each call sends another email, so retrying sends it again. Each invitation can be resent 3 times every 10 minutes.

A 200 means the new link was saved. It doesn't confirm the email was sent. The response body is null.

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>

post/api/workspace/invitations/resend

Query parameters

workspaceIdstring required

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

emailstring required

Email the pending invitation was sent to.

Example request

{
  "email": "dana@acme.com"
}

Response

The invitation has a new link. The body is null.

{"stackTrail":"paths:/api/workspace/invitations/resend:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}

Changes

Changed in 1 of the 39 revisions of this API.1