All tools
ClerkC

by Clerk

Invite a user

Creates an invitation for an email address and sends the invitation email with a link to sign up.

View on GitHub
Updated Sep 26, 2026Available asAPI

Description

Fails if the email address already has an invitation or belongs to an existing user. Invitations expire after a month by default.

create-invitation.md

Invite a user

Creates an invitation for an email address and sends the invitation email with a link to sign up.

Fails if the email address already has an invitation or belongs to an existing user. Invitations expire after a month by default.

Set up

Use the first option your agent supports.

API (official)

Before doing anything else, make one read-only call to confirm access.

Rules

  • Ask the user before anything that sends messages, costs money, or changes data.
  • Never print API keys.

Built from these files in the repository

The layout and the rules come from lib/catalog/render-markdown.ts, the set-up wording from lib/catalog/render-access.ts.

Ways in

RouteSourceCallRequiredDocs
APIOfficialPOST /invitationsAPI key in $CLERK_SECRET_KEYDocs

Workflows using Invite a user

No workflows yet
No published workflow uses Invite a user yet.