> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hexclave.com/llms.txt
> Use this file to discover all available pages before exploring further.

# ContactChannel

> Reference for ContactChannel and ServerContactChannel types for user contact information.

export const MethodReturns = ({type, children}) => <ContentSection title="Returns">
    <code className="inline-flex rounded-md border border-zinc-950/10 bg-zinc-950/[0.04] px-2 py-0.5 text-[13px] font-medium text-zinc-950 dark:border-white/10 dark:bg-white/[0.08] dark:text-white">
      {type}
    </code>
    {children ? <div className="text-sm leading-6 text-zinc-700 dark:text-zinc-300">{children}</div> : null}
  </ContentSection>;

export const MethodLayout = ({children}) => <div className="grid gap-4 md:grid-cols-2 md:items-start xl:gap-6">
    {children}
  </div>;

export const MethodContent = ({children}) => <div className="min-w-0 space-y-4">{children}</div>;

export const MethodAside = ({title, children}) => <div className="min-w-0 self-start space-y-4 rounded-2xl border border-zinc-950/10 bg-zinc-950/[0.02] p-4 dark:border-white/10 dark:bg-white/[0.03]">
    {title ? <p className="m-0 text-sm font-medium text-zinc-950 dark:text-white">{title}</p> : null}
    <div className="space-y-4">{children}</div>
  </div>;

export const ContentSection = ({title, children}) => <div className="space-y-3">
    {title ? <p className="m-0 text-sm font-medium text-zinc-950 dark:text-white">{title}</p> : null}
    <div className="space-y-3">{children}</div>
  </div>;

export const CollapsibleTypesSection = ({type, property, signature, defaultOpen = false, deprecated = false, badge, children}) => {
  const id = `${String(type ?? "").toLowerCase().replace(/[^a-z0-9]/g, "")}${String(property ?? "").toLowerCase().replace(/[^a-z0-9]/g, "")}`;
  const [isOpen, setIsOpen] = useState(defaultOpen);
  useEffect(() => {
    if (typeof window === "undefined") {
      return undefined;
    }
    const syncWithHash = () => {
      if (window.location.hash === `#${id}`) {
        setIsOpen(true);
      }
    };
    syncWithHash();
    window.addEventListener("hashchange", syncWithHash);
    return () => window.removeEventListener("hashchange", syncWithHash);
  }, [id]);
  const label = signature ? `${property}(${signature})` : property;
  const fullLabel = type ? `${type}.${label}` : label;
  return <details id={id} open={isOpen} onToggle={event => setIsOpen(event.currentTarget.open)} className={`not-prose my-4 scroll-mt-24 overflow-hidden rounded-2xl border bg-white dark:bg-zinc-950 ${deprecated ? "border-orange-400/40 dark:border-orange-500/30" : "border-zinc-950/10 dark:border-white/10"}`}>
      <summary className="cursor-pointer list-none px-4 py-4 [&::-webkit-details-marker]:hidden">
        <div className="flex items-center gap-3">
          <code className={`text-[15px] font-medium ${deprecated ? "text-zinc-500 line-through decoration-zinc-400/60 dark:text-zinc-400 dark:decoration-zinc-500/60" : "text-zinc-950 dark:text-white"}`}>{fullLabel}</code>
          <span className="ml-auto flex items-center gap-2">
            {deprecated ? <Badge color="orange" size="sm" shape="pill">deprecated</Badge> : null}
            {badge ?? null}
            <span aria-hidden="true" className="text-sm text-zinc-500 transition-transform dark:text-zinc-400">
              {isOpen ? "▾" : "›"}
            </span>
          </span>
        </div>
      </summary>

      <div className="border-t border-zinc-950/10 px-4 py-5 dark:border-white/10">
        {children}
      </div>
    </details>;
};

export const ClickableTableOfContents = ({title, code}) => {
  const lines = String(code ?? "").replace(/\r\n/g, "\n").split("\n");
  return <div className="not-prose my-6 overflow-hidden rounded-2xl border border-zinc-950/10 bg-zinc-950/[0.03] dark:border-white/10 dark:bg-white/[0.03]">
      {title ? <div className="border-b border-zinc-950/10 px-4 py-3 text-sm font-medium text-zinc-950/80 dark:border-white/10 dark:text-white/80">
          {title}
        </div> : null}

      <pre className="overflow-x-auto px-2 py-3 text-[13px] leading-6 text-zinc-900 dark:text-zinc-100">
        <code>
          {lines.map((line, index) => {
    if (line.trim().startsWith("// NEXT_LINE_PLATFORM")) {
      return null;
    }
    const match = line.match(/^(.*?)(?:\s*\/\/\s*\$stack-link-to:(#[a-zA-Z0-9_-]+))\s*$/);
    const href = match?.[2] ?? null;
    const text = match?.[1] ?? line;
    if (text.trim() === "") {
      return <span key={`blank-${index}`} className="block h-6" />;
    }
    const content = <span className="block whitespace-pre rounded-lg px-3 py-0.5">
                {text.replace(/\s+$/, "")}
              </span>;
    if (!href) {
      return <span key={`line-${index}`} className="block text-zinc-700 dark:text-zinc-300">
                  {content}
                </span>;
    }
    return <a key={`line-${index}`} href={href} className="block no-underline transition-colors hover:bg-zinc-950/[0.04] hover:text-zinc-950 dark:hover:bg-white/[0.05] dark:hover:text-white">
                {content}
              </a>;
  })}
        </code>
      </pre>
    </div>;
};

export const AsideSection = ({title, children}) => <div className="space-y-3">
    {title ? <p className="m-0 text-sm font-medium text-zinc-950 dark:text-white">{title}</p> : null}
    <div className="space-y-3">{children}</div>
  </div>;

export const ContactChannelSection = props => <CollapsibleTypesSection badge={<Badge color="green" size="sm" shape="pill">
        contactChannel
      </Badge>} {...props} />;

export const ServerContactChannelSection = props => <CollapsibleTypesSection badge={<Badge color="blue" size="sm" shape="pill">
        serverContactChannel
      </Badge>} {...props} />;

`ContactChannel` represents a user's contact information, such as an email address or phone number. Some auth methods, like OTP/magic link or password, use contact channels for authentication.

On this page:

* [`ContactChannel`](#contactchannel)
* [`ServerContactChannel`](#servercontactchannel)

# `ContactChannel`

Basic information about a contact channel, as seen by a user themselves.

Usually obtained by calling [`user.listContactChannels()`](/sdk/types/user#currentuserlistcontactchannels) or [`user.useContactChannels()`](/sdk/types/user#currentuserusecontactchannels).

## Table of Contents

<ClickableTableOfContents
  title="ContactChannel Table of Contents"
  code={`type ContactChannel = {
id: string; //$stack-link-to:#contactchannelid
value: string; //$stack-link-to:#contactchannelvalue
type: "email"; //$stack-link-to:#contactchanneltype
isPrimary: boolean; //$stack-link-to:#contactchannelisprimary
isVerified: boolean; //$stack-link-to:#contactchannelisverified
usedForAuth: boolean; //$stack-link-to:#contactchannelusedforauth

sendVerificationEmail([options]): Promise<void>; //$stack-link-to:#contactchannelsendverificationemail
update(options): Promise<void>; //$stack-link-to:#contactchannelupdate
delete(): Promise<void>; //$stack-link-to:#contactchanneldelete
};`}
/>

## Properties

<ContactChannelSection type="contactChannel" property="id" defaultOpen={false}>
  <MethodLayout>
    <MethodContent>
      The ID of the contact channel.
    </MethodContent>

    <MethodAside title="Type Definition">
      `typescript declare const id: string; `
    </MethodAside>
  </MethodLayout>
</ContactChannelSection>

<ContactChannelSection type="contactChannel" property="value" defaultOpen={false}>
  <MethodLayout>
    <MethodContent>
      The value of the contact channel. If the type is `"email"`, this is an email address.
    </MethodContent>

    <MethodAside title="Type Definition">
      `typescript declare const value: string; `
    </MethodAside>
  </MethodLayout>
</ContactChannelSection>

<ContactChannelSection type="contactChannel" property="type" defaultOpen={false}>
  <MethodLayout>
    <MethodContent>
      The type of contact channel. Currently this is always `"email"`.
    </MethodContent>

    <MethodAside title="Type Definition">
      `typescript declare const type: "email"; `
    </MethodAside>
  </MethodLayout>
</ContactChannelSection>

<ContactChannelSection type="contactChannel" property="isPrimary" defaultOpen={false}>
  <MethodLayout>
    <MethodContent>
      Whether the contact channel is the user's primary contact method. If an email is set to primary, it will be the value on `user.primaryEmail`.
    </MethodContent>

    <MethodAside title="Type Definition">
      `typescript declare const isPrimary: boolean; `
    </MethodAside>
  </MethodLayout>
</ContactChannelSection>

<ContactChannelSection type="contactChannel" property="isVerified" defaultOpen={false}>
  <MethodLayout>
    <MethodContent>
      Whether the contact channel is verified.
    </MethodContent>

    <MethodAside title="Type Definition">
      `typescript declare const isVerified: boolean; `
    </MethodAside>
  </MethodLayout>
</ContactChannelSection>

<ContactChannelSection type="contactChannel" property="usedForAuth" defaultOpen={false}>
  <MethodLayout>
    <MethodContent>
      Whether the contact channel is used for authentication. If `true`, the user can use this contact channel with OTP or password to sign in.
    </MethodContent>

    <MethodAside title="Type Definition">
      `typescript declare const usedForAuth: boolean; `
    </MethodAside>
  </MethodLayout>
</ContactChannelSection>

## Methods

<ContactChannelSection type="contactChannel" property="sendVerificationEmail" signature="[options]" defaultOpen={false}>
  <MethodLayout>
    <MethodContent>
      Sends a verification email to this contact channel. Once the user clicks the verification link in the email, the contact channel will be marked as verified.

      <ContentSection title="Parameters">
        <ParamField body="options.callbackUrl" type="string">
          The URL to redirect to after the user clicks the verification link.
        </ParamField>
      </ContentSection>

      <MethodReturns type="Promise<void>" />
    </MethodContent>

    <MethodAside>
      <AsideSection title="Signature">
        ```typescript theme={null}
        declare function sendVerificationEmail(options?: {
          callbackUrl?: string;
        }): Promise<void>;
        ```
      </AsideSection>

      <AsideSection title="Examples">
        ```typescript theme={null}
        await contactChannel.sendVerificationEmail();
        ```
      </AsideSection>
    </MethodAside>
  </MethodLayout>
</ContactChannelSection>

<ContactChannelSection type="contactChannel" property="update" signature="options" defaultOpen={false}>
  <MethodLayout>
    <MethodContent>
      Updates the contact channel. After updating the value, the contact channel will be marked as unverified.

      <ContentSection title="Parameters">
        <ParamField body="options.value" type="string">
          The new value of the contact channel.
        </ParamField>

        <ParamField body="options.usedForAuth" type="boolean">
          Whether the contact channel is used for authentication.
        </ParamField>

        <ParamField body="options.isPrimary" type="boolean">
          Whether the contact channel is the user's primary contact channel.
        </ParamField>
      </ContentSection>

      <MethodReturns type="Promise<void>" />
    </MethodContent>

    <MethodAside>
      <AsideSection title="Signature">
        ```typescript theme={null}
        declare function update(options: {
          value?: string;
          usedForAuth?: boolean;
          isPrimary?: boolean;
        }): Promise<void>;
        ```
      </AsideSection>

      <AsideSection title="Examples">
        ```typescript theme={null}
        await contactChannel.update({
          value: "new-email@example.com",
          usedForAuth: true,
        });
        ```
      </AsideSection>
    </MethodAside>
  </MethodLayout>
</ContactChannelSection>

<ContactChannelSection type="contactChannel" property="delete" defaultOpen={false}>
  <MethodLayout>
    <MethodContent>
      Deletes the contact channel.

      <MethodReturns type="Promise<void>" />
    </MethodContent>

    <MethodAside>
      <AsideSection title="Signature">
        ```typescript theme={null}
        declare function delete(): Promise<void>;
        ```
      </AsideSection>

      <AsideSection title="Examples">
        ```typescript theme={null}
        await contactChannel.delete();
        ```
      </AsideSection>
    </MethodAside>
  </MethodLayout>
</ContactChannelSection>

***

# `ServerContactChannel`

Like `ContactChannel`, but includes additional methods and properties that require the `SECRET_SERVER_KEY`.

Usually obtained by calling [`serverUser.listContactChannels()`](/sdk/types/user#serveruserlistcontactchannels) or [`serverUser.useContactChannels()`](/sdk/types/user#serveruserusecontactchannels).

## Table of Contents

<ClickableTableOfContents
  title="ServerContactChannel Table of Contents"
  code={`type ServerContactChannel =
// Inherits all properties from ContactChannel
& ContactChannel; //$stack-link-to:#contactchannel
& {
update(options): Promise<void>; //$stack-link-to:#servercontactchannelupdate
};`}
/>

## Methods

<ServerContactChannelSection type="serverContactChannel" property="update" signature="options" defaultOpen={false}>
  <MethodLayout>
    <MethodContent>
      Updates the contact channel. This method is similar to the one on `ContactChannel`, but also allows setting the `isVerified` property.

      <ContentSection title="Parameters">
        <ParamField body="options.value" type="string">
          The new value of the contact channel.
        </ParamField>

        <ParamField body="options.usedForAuth" type="boolean">
          Whether the contact channel is used for authentication.
        </ParamField>

        <ParamField body="options.isVerified" type="boolean">
          Whether the contact channel is verified.
        </ParamField>

        <ParamField body="options.isPrimary" type="boolean">
          Whether the contact channel is the user's primary contact channel.
        </ParamField>
      </ContentSection>

      <MethodReturns type="Promise<void>" />
    </MethodContent>

    <MethodAside>
      <AsideSection title="Signature">
        ```typescript theme={null}
        declare function update(options: {
          value?: string;
          usedForAuth?: boolean;
          isVerified?: boolean;
          isPrimary?: boolean;
        }): Promise<void>;
        ```
      </AsideSection>

      <AsideSection title="Examples">
        ```typescript theme={null}
        await serverContactChannel.update({
          value: "new-email@example.com",
          usedForAuth: true,
          isVerified: true,
        });
        ```
      </AsideSection>
    </MethodAside>
  </MethodLayout>
</ServerContactChannelSection>