@archastro/sdk
    Preparing search index...

    Class TeamInviteResource

    Index

    Constructors

    Methods

    Constructors

    Methods

    • Create a team invite Generates a new invite code for the specified team. The authenticated user must be a member of the team with the owner or admin role. The returned code is a short alphanumeric string that other users can present to join the team. Each call produces a new code; previously issued codes are not invalidated by this request. Codes expire after seven days. Sharing a code intentionally grants membership across organizations within the same application, including access to objects shared with team members. Treat it as a bearer credential. Revoke an individual code with DELETE /api/v1/teams/:team/invite/:code before issuing a replacement. Revocation does not remove existing members or their access.

      Parameters

      • team: string

        Team ID (tm_...) identifying the team for which to generate the invite code.

      Returns Promise<TeamInvite>

      The newly created team invite containing the join code.

    • Revoke a team invite code Deletes one invite code for this team. Requires an owner or admin membership. Future redemption returns 404, as for an unknown or expired code. Existing memberships and their access are unchanged; remove members separately to end their access. Redemption already in flight is not cancelled. To replace a code, revoke it and then create a new invite. Creating a new invite alone does not invalidate any previous code. Other codes remain valid.

      Parameters

      • team: string

        Team ID (tm_...) identifying the team for which to generate the invite code.

      • code: string

        The invite code to revoke.

      Returns Promise<void>

      No content