envless.invites.revoke()

def revoke(
    id: str,
    *,
    timeout: float | None = None,
) -> RevokedInviteResource

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

Soft-deletes the invitation and kills the link in the email immediately. The recipient is not told, and the seat the invite was holding against your plan limit is released, so this is what you call before inviting someone else on a full plan.

There is no way to undo this. To reach the same address again, call members.invite, which now succeeds because no pending invite is blocking the email. Note that revoking has no effect on anyone who already accepted: once accepted the invite is gone from this collection and the person is a member, so use members.remove instead.

id must be an invite id from a list call. Passing an email address or a slug produces a 404 rather than a validation error, and so does an invite that was already revoked or accepted.

Example#

from envless import envless

invites = envless.invites.list_all(search='dana@example.com')

if invites:
    revoked = envless.invites.revoke(invites[0]['id'])

    print(revoked['email'])

import asyncio

from envless import AsyncEnvless


async def main() -> None:
    async with AsyncEnvless() as envless:
        invites = await envless.invites.list_all(search='dana@example.com')

        if invites:
            revoked = await envless.invites.revoke(invites[0]['id'])

            print(revoked['email'])


asyncio.run(main())

Parameters#

Returns#

RevokedInviteResource with the id and email of the invitation that was revoked.

Worth knowing#

Required scopes#

members:write

Underlying endpoint#

In TypeScript#