{"name":"Lorikeet agent sign-up","description":"Start a Lorikeet self-serve sign-up for a person. Lorikeet emails them a sign-up link; they finish in their own browser, create a workspace and add their own card at checkout. You never pay. Optionally, with their agreement, you can generate their Lorikeet password and send it, so the link signs them straight in (see optionalPassword); otherwise they choose a password when they open the link.","endpoint":{"method":"POST","path":"/v1/agent-signup","contentType":"application/json"},"askTheHuman":["Their work email address (personal mailboxes such as Gmail or Outlook.com are not accepted).","Their first and last name.","Optionally, their company website and the name they want for their workspace.","Optionally, whether they want you to generate their Lorikeet password. If they say yes, generate a new random password (see optionalPassword), show it to them in full and send it only after they confirm they have saved it. Never reuse or ask for a password they already use elsewhere."],"rules":["Only sign up the person you are acting for, with their explicit confirmation of the details, including details you already know about them.","Send the request once. Repeating it does not send another email.","Do not guess or invent details. Leave optional fields out if the person did not give them.","Names and the workspace name must be plain text: no links, markup or control characters.","Only send a password you generated for this sign-up, with personApprovedPassword: true, after the person has seen it and agreed. Do not store it after the request."],"requestBody":{"email":{"type":"string","format":"email","required":true},"firstName":{"type":"string","required":true,"maxLength":64},"lastName":{"type":"string","required":true,"maxLength":64},"companyWebsite":{"type":"string","required":false,"description":"Company website, e.g. acme.com"},"workspaceName":{"type":"string","required":false,"maxLength":100},"password":{"type":"string","required":false,"minLength":20,"maxLength":64,"description":"A password you generated for the person and showed them. Send with personApprovedPassword."},"personApprovedPassword":{"type":"boolean","required":false,"const":true,"description":"true, confirming the person saw the generated password and wants it set. Required with password, not allowed without it."}},"example":{"email":"ada@acme.com","firstName":"Ada","lastName":"Lovelace","companyWebsite":"acme.com","workspaceName":"Acme"},"responses":{"202":{"body":{"status":"sent_if_eligible","next":"Tell the person to open the email from Lorikeet in their inbox and follow the link to finish signing up in their browser. They will create their workspace and add a card at checkout to start the free trial. The link expires in 7 days. If nothing arrives within 10 minutes, they should check their spam folder, or sign up at https://app.lorikeetcx.ai/sign-up instead. You do not need to call this endpoint again."},"meaning":"Accepted. If the person is eligible, Lorikeet has emailed them a sign-up link. The response is the same whether or not an email was sent."},"400":{"meaning":"The request was malformed, or the email is not a work address. The body says which and what to change."},"404":{"meaning":"Agent sign-up is not available right now."},"429":{"meaning":"Too many requests from your network. Wait for the Retry-After header, then retry once."}},"whatHappensNext":["The person receives an email from Lorikeet with a sign-up link.","If you sent a password, the link signs them straight in and they land on workspace setup with the details you sent filled in. If not, they confirm their account and choose a password first.","They add a card at checkout to start the free trial. Nothing is charged until the trial ends."],"optionalPassword":{"howToGenerate":"A new random password of 20 to 64 printable ASCII characters with no spaces, including lower case letters, upper case letters and digits. Use a cryptographically secure random source.","why":"With a password, the email link signs the person straight in instead of asking them to choose one. Without it, they choose their own password when they open the link. Both are fine."}}