MailMasker API
Claude Code
Invites

Invite someone

POST/api/v1/invites

Who can use this: Any signed-in accountAs Markdown

Makes a one-time sign-up link and emails it to them, with your note if you add one. The answer holds the link itself as url, so you can also pass it on another way. It stops working at expires_at.

Parameters

NameWhereWhat it is
recipient_email required body Their email address, where the link is sent.e.g. friend@example.com
message body A note from you, put in the email and shown on the sign-up page.e.g. Come and join me here.
channel body cli (the default) or web, and the email is sent for you. roundcube_plugin sends no email, leaving the link for you to deliver.

Good to know

  • Past your limit of waiting invites, or of invites sent in the last day, the answer is 429 (see See your invite limits).
  • A second invite to someone who already has a pending one from you answers 409. An address that doesn't look like one answers 400.
  • If the email can't be sent, the invite is still made. The answer adds a warning, and the link in url still works.
  • Someone whose address is on one of this system's own mail domains can't use an invite; the sign-up page turns them away.