SUsupabase
admin

Invite a user by email.

Changed on

Sends an invitation email which contains a link that allows the user to sign-in.

post/invite

Request

  • Base URL
    https://abcdefghijklmnopqrst.supabase.co/auth/v1
  • URL
    https://abcdefghijklmnopqrst.supabase.co/auth/v1/invite
  • Auth
    API key in header apikey

Request body

emailstring required
dataobject

Response

An invitation has been sent to the user.

idstring uuid
audstring
rolestring
emailstring

User's primary contact email. In most cases you can uniquely identify a user by their email address, but not in all cases.

email_confirmed_atstring date-time
phonestring phone

User's primary contact phone number. In most cases you can uniquely identify a user by their phone number, but not in all cases.

phone_confirmed_atstring date-time
confirmation_sent_atstring date-time
confirmed_atstring date-time
recovery_sent_atstring date-time
new_emailstring email
email_change_sent_atstring date-time
new_phonestring phone
phone_change_sent_atstring date-time
reauthentication_sent_atstring date-time
last_sign_in_atstring date-time
app_metadataobject
user_metadataobject
banned_untilstring date-time
created_atstring date-time
updated_atstring date-time
deleted_atstring date-time
is_anonymousboolean

Changes

  • a222d9459767Revision changes
    • warning

      removed the optional property // from the response with the status

    • info

      added the optional property // to the response with the status

  • 4d0f1a6c1ad9Revision changes
    • breaking

      the // response's property type changed from jsonb to string for status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status