envless.invites.resend()

def resend(
    id: str,
    *,
    timeout: float | None = None,
) -> InviteResource

async def resend(
    id: str,
    *,
    timeout: float | None = None,
) -> InviteResource

Re-delivers the email for an invite that is still pending. Nothing new is created: the invite keeps its id, its token and its original expiresAt, which means resending does not buy the recipient more time. An invite that has already expired cannot be rescued this way, so revoke it and send a fresh one with members.invite.

A resend is not rate limited. There is no cap on how many times one invite can be sent again and no cooldown between calls, so a recipient who lost the email can be sent another one immediately. Only two things refuse the call:

The returned invite always has 'role': None on this route, since the endpoint does not re-resolve the role. Read the role from a list call if you need it. resendCount and lastResendAt do reflect the bump.

Example#

from envless import envless

invite = envless.invites.resend('inv_2Nk9')

print(invite['resendCount'], invite['lastResendAt'])

import asyncio

from envless import AsyncEnvless


async def main() -> None:
    async with AsyncEnvless() as envless:
        invite = await envless.invites.resend('inv_2Nk9')

        print(invite['resendCount'], invite['lastResendAt'])


asyncio.run(main())

Parameters#

Returns#

InviteResource for the same invite, with an incremented resendCount and a None role.

Worth knowing#

Required scopes#

members:write

Underlying endpoint#

In TypeScript#