Skip to main content

onboarding

onboarding.start_signup​

Start Signup

Effects: write, external_api

🚪 Start a person's own DialogBrain account without a password.

Creates the account if the email is new (it keeps no password, like a Google sign-in), mails a 6-digit sign-in code to that address, and returns the link to send them. Use it for a lead who ASKED to try the product themselves, or who ticked 'create my account' on a form — never for someone who did not ask.

Tell them the code is in the email and give them the returned link: they enter the code and land on the screen that connects their channel. Do NOT ask them for a password and do not send one; there is none. The code is not returned to you, so you cannot read it out — if they say it never arrived, call again after a minute (a second call inside 60s is refused with rate_limited).

Arguments​

ArgumentTypeRequiredDescription
channelstringnoThe channel they want to run their agent on (e.g. 'whatsapp', 'telegram', 'instagram'), usually the one they picked on the form. It decides which connect dialog the returned link opens.
emailstringyesThe address the person gave. The code goes here, nowhere else.