@archastro/sdk
    Preparing search index...

    Interface UserInvite

    A shareable invite created by a user, optionally scoped to a thread. Recipients can use the invite key to join or start a conversation.

    interface UserInvite {
        created_at?: string;
        id: string;
        key?: string;
        metadata?: Record<string, unknown>;
        thread?: string;
        user?: InviteCreator;
    }
    Index

    Properties

    created_at? id key? metadata? thread? user?

    Properties

    created_at?: string

    When this invite was created (ISO 8601).

    id: string

    Invite ID (uin_...).

    key?: string

    Secret bearer token used to accept this invite. Treat this value like a password — do not log or expose it publicly.

    metadata?: Record<string, unknown>

    Arbitrary key-value metadata attached to the invite at creation time. Defaults to an empty object.

    thread?: string

    ID of the thread this invite is scoped to (thr_...). null if the invite is not bound to a thread.

    user?: InviteCreator

    The user who created this invite.

    Settings

    Member Visibility

    On This Page

    Properties