Start a partner application for the person
partner_applyStarts a partner application with the person’s details and returns application_id and application_token. Only call it when the person has asked to join. No text is sent by this call. Next: partner_send_code.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | The person’s name. | |
| Yes | The person’s email. | ||
| persona | Yes | The partner type: how they meet renters (front desk or building staff, leasing agent, mover, tenant insurance, co-living, university, telecom, listing site, relocation, landlord, move-in service, delivery). | |
| building | No | Optional: the building or company they work with. | |
| employer_ok | No | If they work for a building or concierge company: has their employer allowed it? | |
| payouts_off | No | Optional: true for organisations that cannot take money (for example a university or a settlement agency). Their residents still get the perk; no payouts are ever made. | |
| mobile_phone | Yes | The person’s own Canadian mobile number. We text it a code. |